API Reference | developer.brewmp.com API Reference | developer.brewmp.com

Developer

API Reference

IDRAWDECORATOR_GETMODEL()

Brew Release
Brew MP 1.0.2
See Also
- IDrawDecorator Interface - IModel Interface - IDecorator_GetModel() - IDrawDecorator_SetModel()
Description
This function retrieves the model that provides data to a given draw decorator implementation. The model that is returned will implement the interface for the class ID passed to the function in the 'i' parameter
IDrawDecorator_GetModel() inherits wholly from IDecorator_GetModel().
Params
p
[]:
Pointer to the IDrawDecorator object.
i
[]:
The class id of the model the draw decorator will use as a source for data.
ppm
[]:
Pointer to an IModel pointer into which the function will return a pointer to the IModel interface that supports the passed class id.
Interface
Prototype
  •    int IDrawDecorator_GetModel(IDrawDecorator *p, AEECLSID i, IModel **ppm);
       
Return
  •    AEE_SUCCESS - The function was able to successfully locate the model interface
                 identified by the 'i' parameter.
       AEE_EFAILED - The requested model interface is not currently declared.
    

    A pointer to the model interface associated with the draw decorator implementation is returned in 'ppm', or NULL if the draw decorator implementation does utilize a model interface.
Side Effect
  • None
Comments
The pointer passed in the 'ppm' parameter is a double-indirection -- i.e. it is a pointer to a pointer. Applications should use care in ensuring that the proper level of indirection is used in calling the function.