3ds Max C++ API Reference
|
The interface for creating, adding, removing and keeping track of meta-data on max Animatables. More...
#include <IMetaData.h>
Classes | |
struct | ParamDescriptor |
A description for a parameter to be used in a meta-data, and its UI in an eventual rollout. More... | |
Public Types | |
enum | ControlAlign { eAlignLeft , eAlignCenter , eAlignRight } |
typedef Class_ID | MetaDataID |
![]() | |
enum | LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled } |
Public Member Functions | |
virtual MetaDataID | CreateMetaDataDefinition (const MCHAR *in_custAttribSetName, const MCHAR *in_rollOutName, const Tab< ParamDescriptor > &in_paramDefs, MSTR *out_errMsg=NULL)=0 |
Create a meta-data definition for further use in meta-data manager functions. | |
virtual CustAttrib * | AddMetaDataToAnimatable (const MetaDataID &in_metaDataID, Animatable &in_animatable, int in_rank=-1)=0 |
Create a meta-data instance and add it to the custom attribute container of an animatable. | |
virtual void | AddMetaDataToAnimatables (const MetaDataID &in_metaDataID, const Tab< Animatable * > &in_animatables, Tab< CustAttrib * > &out_metaData, bool in_shared=false, int in_rank=-1)=0 |
Create meta-data instances and add it to the custom attribute container of animatables. | |
virtual bool | RemoveMetaDataFromAnimatable (const MetaDataID &in_metaDataID, Animatable &in_animatable)=0 |
Remove a meta-data from the custom attribute container of an animatable. | |
virtual int | MetaDataCount () const =0 |
Returns the number of meta-data in the scene. | |
virtual void | GetAllMetaDataOwners (const MetaDataID &in_ID, Tab< Animatable * > &out_owners)=0 |
Finds all owners of meta-data of a given meta-data ID. | |
virtual bool | IsMetaDataDefined (const MetaDataID &in_ID) const =0 |
Returns whether a definition exists for a given meta-data ID. | |
virtual CustAttrib * | GetMetaData (Animatable &in_animatable, const MetaDataID &in_ID) const =0 |
Checks the existence of meta-data of a given ID on an animatable. | |
virtual void | GetAllMetaData (Animatable &in_animatable, Tab< CustAttrib * > &out_metaData) const =0 |
Finds all meta-data on an animatable. | |
![]() | |
CoreExport | FPInterfaceDesc () |
CoreExport | FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...) |
CoreExport | ~FPInterfaceDesc () |
virtual void | Init () |
LifetimeType | LifetimeControl () |
virtual BaseInterface * | GetInterface (Interface_ID id) |
CoreExport void | LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...) |
CoreExport void | AppendFunction (int id,...) |
Add a new function to this interface descriptor. | |
CoreExport void | AppendProperty (int id,...) |
Add a new property to this interface descriptor. | |
CoreExport void | AppendEnum (int id,...) |
Add a new enum to this interface descriptor. | |
CoreExport void | SetClassDesc (ClassDesc *i_cd) |
CoreExport va_list | check_fn (va_list ap, int id) |
CoreExport va_list | scan_fn (va_list ap, int id, int index) |
CoreExport va_list | check_prop (va_list ap, int id) |
CoreExport va_list | scan_prop (va_list ap, int id, int index) |
CoreExport va_list | check_enum (va_list ap, EnumID id) |
CoreExport va_list | scan_enum (va_list ap, EnumID id, int index) |
FPInterfaceDesc * | GetDesc () |
Interface_ID | GetID () |
CoreExport FPFunctionDef * | GetFnDef (FunctionID fid) |
ActionTable * | GetActionTable () |
CoreExport void | EnableActions (BOOL onOff) |
virtual CoreExport HINSTANCE | HInstance () |
virtual CoreExport const MCHAR * | GetRsrcString (StringResID id) |
![]() | |
virtual BaseInterface * | GetInterface (Interface_ID id) |
virtual FPInterfaceDesc * | GetDesc ()=0 |
virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL) |
virtual FPStatus | Invoke (FunctionID fid, FPParams *params) |
virtual CoreExport FPStatus | Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL) |
virtual FPStatus | Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL) |
virtual CoreExport FunctionID | FindFn (const MCHAR *name) |
virtual CoreExport BOOL | IsEnabled (FunctionID actionID) |
virtual CoreExport BOOL | IsChecked (FunctionID actionID) |
virtual CoreExport BOOL | IsVisible (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsEnabled (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsChecked (FunctionID actionID) |
virtual CoreExport FunctionID | GetIsVisible (FunctionID actionID) |
virtual ActionTable * | GetActionTable () |
virtual void | EnableActions (BOOL onOff) |
![]() | |
virtual UtilExport | ~BaseInterface () |
Destructor. | |
UtilExport BaseInterface * | GetInterface (Interface_ID id) override |
virtual UtilExport Interface_ID | GetID () |
virtual LifetimeType | LifetimeControl () |
virtual bool | RegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual void | UnRegisterNotifyCallback (InterfaceNotifyCallback *incb) |
virtual BaseInterface * | AcquireInterface () |
virtual void | ReleaseInterface () |
virtual void | DeleteInterface () |
virtual BaseInterface * | CloneInterface (void *remapDir=nullptr) |
![]() | |
virtual UtilExport | ~InterfaceServer () |
Destructor. | |
virtual UtilExport BaseInterface * | GetInterface (Interface_ID id) |
template<class InterfaceType > | |
InterfaceType * | GetTypedInterface () |
Static Public Member Functions | |
static IMetaDataManager * | GetInstance () |
![]() | |
static UtilExport void * | operator new (size_t size) |
Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e) |
Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new (size_t size, const char *filename, int line) |
New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, const char *filename, int line) |
New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new (size_t size, unsigned long flags) |
New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, const std::nothrow_t &e, unsigned long flags) |
New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size, const char *filename, int line) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, int block_type, const char *filename, int line) |
New operator used to allocate arrays of objects. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void * | operator new[] (size_t size, unsigned long flags) |
New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. | |
static UtilExport void * | operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags) |
New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. | |
static UtilExport void | operator delete (void *ptr) |
Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e) |
Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete (void *ptr, const char *filename, int line) |
Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, int block_type, const char *filename, int line) |
Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete (void *ptr, unsigned long flags) |
Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags) |
Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr) |
Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e) |
Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, int block_type, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line) |
Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. | |
static UtilExport void | operator delete[] (void *ptr, unsigned long flags) |
Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void | operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags) |
Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. | |
static UtilExport void * | operator new (size_t size, void *placement_ptr) |
Placement new operator. | |
static UtilExport void | operator delete (void *ptr, void *placement_ptr) |
Placement delete operator. | |
static UtilExport void * | aligned_malloc (size_t size, size_t alignment) |
Allocates memory on a specified alignment boundary. | |
static UtilExport void * | aligned_realloc (void *ptr, size_t size, size_t alignment) |
Reallocates memory on a specified alignment boundary. | |
static UtilExport void | aligned_free (void *ptr) |
Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. | |
Additional Inherited Members | |
![]() | |
Interface_ID | ID |
MSTR | internal_name |
StringResID | description |
ClassDesc * | cd |
USHORT | flags |
Tab< FPFunctionDef * > | functions |
Tab< FPPropDef * > | props |
Tab< FPEnum * > | enumerations |
MSPluginClass * | pc |
Rollout * | rollout |
ActionTable * | action_table |
![]() | |
static CoreExport FPInterfaceDesc | nullInterface |
![]() | |
CoreExport void | load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap) |
![]() | |
virtual FPStatus | _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p) |
The interface for creating, adding, removing and keeping track of meta-data on max Animatables.
Meta-data are custom attributes that contain only a parameter block. In order to create meta-data, you have to create its definition by specify the parameters first. This will give you a meta-data ID. You can then use that ID to add, remove or list meta-data in the scene.
typedef Class_ID MetaDataID |
enum ControlAlign |
Enumerator | |
---|---|
eAlignLeft | |
eAlignCenter | |
eAlignRight |
|
pure virtual |
Create a meta-data definition for further use in meta-data manager functions.
The ID returned will allow the user to add or remove meta-data in the scene and to keep track of them.
in_custAttribSetName | - a name for the custom attribute set. |
in_rollOutName | - a name for an eventual rollout. |
in_paramDefs | - an array of descriptions for each parameter in the param block. |
out_errMsg | - (optional): pointer to a MSTR. If non-null and the definition cannot be created, will contain a description of the reason. |
|
pure virtual |
Create a meta-data instance and add it to the custom attribute container of an animatable.
If the meta-data already exists for an animatable, it will not get added.
in_metaDataID | - the meta-data ID of the custom attribute set to be created. |
in_animatable | - the Animatable to which the custom attribute set will be added. |
in_rank | - the insertion index of the custom attribute. Default is to append |
|
pure virtual |
Create meta-data instances and add it to the custom attribute container of animatables.
If the meta-data already exists for an animatable, it will not get added.
in_metaDataID | - the meta-data ID of the custom attribute set to be created. |
in_animatables | - an array of Animatables to which the custom attribute set will be added. |
out_metaData | - an array of MetaData that were created successfully. |
in_shared | - if true, a single instance will be created and shared by all animatables. |
in_rank | - the insertion index of the custom attribute. Default is to append |
|
pure virtual |
Remove a meta-data from the custom attribute container of an animatable.
in_metaDataID | - the meta-data ID of the custom attribute to be removed. |
in_animatable | - the Animatable from which the custom attribute set will be removed. |
|
pure virtual |
Returns the number of meta-data in the scene.
|
pure virtual |
Finds all owners of meta-data of a given meta-data ID.
in_ID | - the meta-data ID of the meta-data. |
out_owners | - an array of Animatables that own meta-data of the given ID. |
|
pure virtual |
Returns whether a definition exists for a given meta-data ID.
in_ID | - the meta-data ID to be checked. |
|
pure virtual |
Checks the existence of meta-data of a given ID on an animatable.
in_animatable | - the animatable to be checked for meta-data. |
in_ID | - the meta-data ID to be checked. |
|
pure virtual |
Finds all meta-data on an animatable.
in_animatable | - the animatable to be checked for meta-data. |
out_metaData | - an array of the meta-data on the Animatable. |
|
inlinestatic |