3ds Max C++ API Reference
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
ILayerRoot Class Referenceabstract

#include <ILayerRoot.h>

+ Inheritance diagram for ILayerRoot:

Public Member Functions

virtual int AppendLayer (const MSTR &name, const MCHAR *method)=0
 
virtual BOOL InsertLayer (const MSTR &name, int layer, const MCHAR *method)=0
 
virtual void RemoveLayer (int layer)=0
 
virtual void MoveLayerUp (int layer)=0
 
virtual void MoveLayerDown (int layer)=0
 
virtual int NumLayers () const =0
 
virtual Color GetLayerColor (int index)=0
 Get the indexed layers color.
 
virtual BOOL SetLayerColor (int index, Color *newColor)=0
 Set the indexed layers color.
 
virtual void SelectLayer (int layer)=0
 
virtual void SelectNone ()=0
 
virtual int GetSelectedLayer () const =0
 
virtual void SoloLayer (int layer)=0
 
virtual void SoloNone ()=0
 
virtual int GetSoloLayer () const =0
 
virtual BOOL IsLayerSolo (int layer)=0
 
virtual BOOL SaveClip (const MSTR &filename, TimeValue start_t, TimeValue end_t, int from_layer, int to_layer)=0
 
virtual BOOL SavePose (const MSTR &filename)=0
 
virtual INodeLoadClip (const MSTR &filename, TimeValue t, BOOL scale_data=TRUE, BOOL transformData=TRUE, BOOL mirrorData=FALSE, BOOL mirrorWorldX=FALSE, BOOL mirrorWorldY=FALSE)=0
 
virtual INodeLoadPose (const MSTR &filename, TimeValue t, BOOL scale_data=TRUE, BOOL transformData=TRUE, BOOL mirrorData=FALSE, BOOL mirrorWorldX=FALSE, BOOL mirrorWorldY=FALSE)=0
 
virtual MSTR GetFileTagValue (const MSTR &filename, const MSTR &tag)=0
 
virtual BOOL LoadHTR (const MSTR &filename, const MSTR &camfile)=0
 
virtual BOOL LoadBVH (const MSTR &filename, const MSTR &camfile)=0
 
virtual BOOL LoadFBX (const MSTR &filename, const MSTR &camfile)=0
 
virtual BOOL LoadBIP (const MSTR &filename, const MSTR &camfile)=0
 
virtual void CollapsePoseToCurLayer (TimeValue t)=0
 
virtual BOOL CollapseTimeRangeToLayer (TimeValue start_t, TimeValue end_t, TimeValue iKeyFreq, BOOL regularplot, int numpasses, float posdelta, float rotdelta)=0
 
virtual int GetTrackDisplayMethod () const =0
 
virtual void SetTrackDisplayMethod (int n)=0
 
virtual void CopyLayer (int n)=0
 
virtual void PasteLayer (BOOL instance, BOOL duplicatelayerinfo)=0
 
virtual INodeCreatePasteLayerTransformNode ()=0
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDesc ()=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 ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
 
UtilExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual UtilExport Interface_ID GetID ()
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Additional Inherited Members

- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator 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 voidoperator 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 voidoperator 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_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.
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

Member Function Documentation

◆ AppendLayer()

virtual int AppendLayer ( const MSTR name,
const MCHAR method 
)
pure virtual

◆ InsertLayer()

virtual BOOL InsertLayer ( const MSTR name,
int  layer,
const MCHAR method 
)
pure virtual

◆ RemoveLayer()

virtual void RemoveLayer ( int  layer)
pure virtual

◆ MoveLayerUp()

virtual void MoveLayerUp ( int  layer)
pure virtual

◆ MoveLayerDown()

virtual void MoveLayerDown ( int  layer)
pure virtual

◆ NumLayers()

virtual int NumLayers ( ) const
pure virtual

◆ GetLayerColor()

virtual Color GetLayerColor ( int  index)
pure virtual

Get the indexed layers color.


This is the color that will be set to a nodes wire color when "Rig Coloring Mode" is set to "by layer".

Parameters
index- The index of the layer to get the color of. This must be the index of an absolute layer.
Returns
The color of the specified layer, if valid, or black

◆ SetLayerColor()

virtual BOOL SetLayerColor ( int  index,
Color *  newColor 
)
pure virtual

Set the indexed layers color.


This is the color that will be set to a nodes wire color when "Rig Coloring Mode" is set to "by layer".

Parameters
index- The index of the layer to get the color of. This must be the index of an absolute layer.
newColor- The color being set to the layer.
Returns
True if the color is set correctly, false if the method fails

◆ SelectLayer()

virtual void SelectLayer ( int  layer)
pure virtual

◆ SelectNone()

virtual void SelectNone ( )
pure virtual

◆ GetSelectedLayer()

virtual int GetSelectedLayer ( ) const
pure virtual

◆ SoloLayer()

virtual void SoloLayer ( int  layer)
pure virtual

◆ SoloNone()

virtual void SoloNone ( )
pure virtual

◆ GetSoloLayer()

virtual int GetSoloLayer ( ) const
pure virtual

◆ IsLayerSolo()

virtual BOOL IsLayerSolo ( int  layer)
pure virtual

◆ SaveClip()

virtual BOOL SaveClip ( const MSTR filename,
TimeValue  start_t,
TimeValue  end_t,
int  from_layer,
int  to_layer 
)
pure virtual

◆ SavePose()

virtual BOOL SavePose ( const MSTR filename)
pure virtual

◆ LoadClip()

virtual INode * LoadClip ( const MSTR filename,
TimeValue  t,
BOOL  scale_data = TRUE,
BOOL  transformData = TRUE,
BOOL  mirrorData = FALSE,
BOOL  mirrorWorldX = FALSE,
BOOL  mirrorWorldY = FALSE 
)
pure virtual

◆ LoadPose()

virtual INode * LoadPose ( const MSTR filename,
TimeValue  t,
BOOL  scale_data = TRUE,
BOOL  transformData = TRUE,
BOOL  mirrorData = FALSE,
BOOL  mirrorWorldX = FALSE,
BOOL  mirrorWorldY = FALSE 
)
pure virtual

◆ GetFileTagValue()

virtual MSTR GetFileTagValue ( const MSTR filename,
const MSTR tag 
)
pure virtual

◆ LoadHTR()

virtual BOOL LoadHTR ( const MSTR filename,
const MSTR camfile 
)
pure virtual

◆ LoadBVH()

virtual BOOL LoadBVH ( const MSTR filename,
const MSTR camfile 
)
pure virtual

◆ LoadFBX()

virtual BOOL LoadFBX ( const MSTR filename,
const MSTR camfile 
)
pure virtual

◆ LoadBIP()

virtual BOOL LoadBIP ( const MSTR filename,
const MSTR camfile 
)
pure virtual

◆ CollapsePoseToCurLayer()

virtual void CollapsePoseToCurLayer ( TimeValue  t)
pure virtual

◆ CollapseTimeRangeToLayer()

virtual BOOL CollapseTimeRangeToLayer ( TimeValue  start_t,
TimeValue  end_t,
TimeValue  iKeyFreq,
BOOL  regularplot,
int  numpasses,
float  posdelta,
float  rotdelta 
)
pure virtual

◆ GetTrackDisplayMethod()

virtual int GetTrackDisplayMethod ( ) const
pure virtual

◆ SetTrackDisplayMethod()

virtual void SetTrackDisplayMethod ( int  n)
pure virtual

◆ CopyLayer()

virtual void CopyLayer ( int  n)
pure virtual

◆ PasteLayer()

virtual void PasteLayer ( BOOL  instance,
BOOL  duplicatelayerinfo 
)
pure virtual

◆ CreatePasteLayerTransformNode()

virtual INode * CreatePasteLayerTransformNode ( )
pure virtual