BRender Technical Reference Manual:4 Data Structures (Alphabetical Reference):br_model_find_cbfn
Next|Prev|Up
The Call-Back Function
Specification
CBFnModelFind()

br_model_find_cbfn


The Call-Back Function

This type defines a function, registered with BrModelFindHook()
241, to be called when BrModelFind()240 or BrModelFindMany()241 fail to find any model.

The typedef

(See fwproto.h for a precise declaration)

br_model* br_model_find_cbfn(const char*) Find (when BrModelFind() fails)

Specification


CBFnModelFind()

Description:
An application defined call-back function used when BrModelFind()
240 or BrModelFindMany()241 fail.

Declaration:
br_model* BR_CALLBACK CBFnModelFind(const char* name)

Arguments:
const char * name

The search pattern supplied to BrModelFind()240 or BrModelFindMany()241 that did not match any model.

Preconditions:
BRender has completed initialisation. No model has an identifier that successfully matches the search pattern.

Effects:
Application defined.

Result:
br_model *

Either return an existing model that is deemed appropriate for the search pattern, or Null if there isn't one. This value will be returned by BrModelFind()240 or BrModelFindMany()241.

Remarks:
This could either be used to supply a default model or to create a model. If models were created on demand, then this function could search another list of available models (but not yet created) and see if the pattern matched any of them, if it did, one of them could be registered and returned. Note that there is no way to supply more than one model.

See Also:
BrModelFind()240, BrModelFindMany()241, BrModelFindHook()241, BrModelFindFailedLoad()242.



Generated with CERN WebMaker