3ds Max C++ API Reference
PFSimpleActionState Class Reference

#include <PFSimpleActionState.h>

+ Inheritance diagram for PFSimpleActionState:

Public Member Functions

int NumInterfaces () const
 
BaseInterfaceGetInterfaceAt (int index) const
 
BaseInterfaceGetInterface (Interface_ID id)
 
void DeleteIObject ()
 
Class_ID GetClassID ()
 The method returns the unique ID for the action state class. More...
 
ULONG GetActionHandle () const
 Returns node handle of the action with the action state. More...
 
void SetActionHandle (ULONG handle)
 Defines node handle of the action with the action state. More...
 
IOResult Save (ISave *isave) const
 Saving content of the action state to file. More...
 
IOResult Load (ILoad *iload)
 Loading content of the action state from file. More...
 
const RandGeneratorrandGen () const
 
RandGenerator_randGen ()
 
- Public Member Functions inherited from IObject
virtual const MCHARGetIObjectName ()
 
virtual void AcquireIObject ()
 
virtual void ReleaseIObject ()
 
- Public Member Functions inherited from BaseInterfaceServer
virtual UtilExport ~BaseInterfaceServer ()
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 
- Public Member Functions inherited from IPFActionState
FPInterfaceDescGetDesc ()
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
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. More...
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 

Protected Member Functions

ULONG actionHandle () const
 
ULONG & _actionHandle ()
 
- 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)
 

Additional Inherited Members

- Public Types inherited from IPFActionState
enum  {
  kChunkActionHandle = 4100 , kChunkRandGen = 4200 , kChunkRandGen2 = 4210 , kChunkRandGen3 = 4220 ,
  kChunkRandGen4 = 4230 , kChunkRandGen5 = 4240 , kChunkData = 4300 , kChunkData2 = 4310 ,
  kChunkData3 = 4320 , kChunkData4 = 4330 , kChunkData5 = 4340
}
 
- 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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator. More...
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator. More...
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary. More...
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Protected Attributes inherited from BaseInterfaceServer
Tab< BaseInterface * > interfaces
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

Member Function Documentation

◆ NumInterfaces()

int NumInterfaces ( ) const
inlinevirtual
Remarks
This method returns the number of interfaces.
Default Implementation:
{ return interfaces.Count(); }

Reimplemented from BaseInterfaceServer.

27 { return 1; }

◆ GetInterfaceAt()

BaseInterface* GetInterfaceAt ( int  i) const
inlinevirtual
Remarks
This method returns a pointer to the BaseInterface of the I-th interface.
Parameters:
int i

The index of the interface in the table.
Default Implementation:
{ return interfaces[i]; }

Reimplemented from BaseInterfaceServer.

28 { return ((index == 0) ? (IPFActionState*)this : NULL); }
#define NULL
Definition: autoptr.h:18
Definition: IPFActionState.h:30

◆ GetInterface()

BaseInterface* GetInterface ( Interface_ID  id)
virtual
Remarks
This method returns a pointer to the BaseInterface of the specified interface.
Parameters:
Interface_ID id

The interface ID for which to return the BaseInterface.

Reimplemented from BaseInterfaceServer.

◆ DeleteIObject()

void DeleteIObject ( )
virtual
Remarks
This method is the virtual destructor for the IObject.
Default Implementation:
{ }

Reimplemented from IObject.

◆ GetClassID()

Class_ID GetClassID ( )
inlinevirtual

The method returns the unique ID for the action state class.

The ID is used for constructing the action state when loading since the action state class is not inherited from class Animatable.

Implements IPFActionState.

#define PFSimpleActionState_Class_ID
Definition: PFClassIDs.h:174

◆ GetActionHandle()

ULONG GetActionHandle ( ) const
inlinevirtual

Returns node handle of the action with the action state.

Implements IPFActionState.

34 { return actionHandle(); }
ULONG actionHandle() const
Definition: PFSimpleActionState.h:47

◆ SetActionHandle()

void SetActionHandle ( ULONG  actionHandle)
inlinevirtual

Defines node handle of the action with the action state.

Implements IPFActionState.

35 { _actionHandle() = handle; }
ULONG & _actionHandle()
Definition: PFSimpleActionState.h:49

◆ Save()

IOResult Save ( ISave isave) const
virtual

Saving content of the action state to file.

Implements IPFActionState.

◆ Load()

IOResult Load ( ILoad iload)
virtual

Loading content of the action state from file.

Implements IPFActionState.

◆ randGen()

const RandGenerator* randGen ( ) const
inline
41 { return &m_randGen; }

◆ _randGen()

RandGenerator* _randGen ( )
inline
43 { return &m_randGen; }

◆ actionHandle()

ULONG actionHandle ( ) const
inlineprotected
47 { return m_actionHandle; }

◆ _actionHandle()

ULONG& _actionHandle ( )
inlineprotected
49 { return m_actionHandle; }