IAssembly Class Reference

IAssembly Class Referenceabstract

#include <iassembly.h>

Class Description

This interface class allows for setting and retrieving assembly membership information to or from nodes.

All methods are implemented by the system (Max). Client code can query an INode for this interface:

INode* n;

IAssembly* a = GetAssemblyInterface(n);

+ Inheritance diagram for IAssembly:

Public Types

enum  MethodID {
  E_SET_ASSEMBLY_MEMBER, E_GET_ASSEMBLY_MEMBER, E_SET_ASSEMBLY_HEAD, E_GET_ASSEMBLY_HEAD,
  E_SET_ASSEMBLY_MEMBER_OPEN, E_GET_ASSEMBLY_MEMBER_OPEN, E_SET_ASSEMBLY_HEAD_OPEN, E_GET_ASSEMBLY_HEAD_OPEN,
  E_SET_ASSEMBLY_BBOX_DISPLAY, E_GET_ASSEMBLY_BBOX_DISPLAY
}
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }
 

Public Member Functions

virtual void SetAssemblyMember (BOOL b)=0
 
virtual void SetAssemblyMemberOpen (BOOL b)=0
 
virtual void SetAssemblyHead (BOOL b)=0
 
virtual void SetAssemblyHeadOpen (BOOL b)=0
 
virtual BOOL IsAssemblyMember () const =0
 
virtual BOOL IsAssemblyHead () const =0
 
virtual BOOL IsAssemblyMemberOpen () const =0
 
virtual BOOL IsAssemblyHeadOpen () const =0
 
virtual BOOL IsAssemblyHeadMemberOf (const IAssembly *const assemblyHead) const =0
 
virtual void SetAssemblyBBoxDisplay (BOOL b)=0
 Methods to control the display of an assembly's world space bounding box. More...
 
virtual BOOL GetAssemblyBBoxDisplay ()=0
 Method to retrieve the value of the bounding box display flag. More...
 
virtual IOResult Save (ISave *isave)=0
 
virtual IOResult Load (ILoad *iload)=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 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. More...
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=NULL)
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor. More...
 

Additional Inherited Members

- 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 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 Enumeration Documentation

enum MethodID
Enumerator
E_SET_ASSEMBLY_MEMBER 
E_GET_ASSEMBLY_MEMBER 
E_SET_ASSEMBLY_HEAD 
E_GET_ASSEMBLY_HEAD 
E_SET_ASSEMBLY_MEMBER_OPEN 
E_GET_ASSEMBLY_MEMBER_OPEN 
E_SET_ASSEMBLY_HEAD_OPEN 
E_GET_ASSEMBLY_HEAD_OPEN 
E_SET_ASSEMBLY_BBOX_DISPLAY 
E_GET_ASSEMBLY_BBOX_DISPLAY 

Member Function Documentation

virtual void SetAssemblyMember ( BOOL  b)
pure virtual
Remarks
Method for setting state of assembly member. To close an assembly member call SetAssemblyMemberOpen(FALSE), as documented below.

Parameters:
BOOL b

Specifies a new state for an assembly member.

If TRUE the node is set as an assembly member.

If FALSE removes a closed or open assembly member from membership. An open member will be closed first and then have it's membership flag removed.

virtual void SetAssemblyMemberOpen ( BOOL  b)
pure virtual
Remarks
Method for opening or closing an assembly member. It should only be called on members.

Parameters:
BOOL b

Specifies the state of the assembly member.

If TRUE the assembly member is opened.

If FALSE the assembly member is closed.

virtual void SetAssemblyHead ( BOOL  b)
pure virtual
Remarks
Method to designate an assembly member as the assembly head.

Parameters:
BOOL b

Specifies the head state of the member.

If TRUE the node is set as the assembly head.

If FALSE an open or closed assembly head becomes a non-head. If the head is open, it is first closed and then the head flag is removed. To close an assembly head call SetAssemblyHeadOpen(FALSE), as documented below.

virtual void SetAssemblyHeadOpen ( BOOL  b)
pure virtual
Remarks
Method for opening or closing an assembly head. It should only be called on an assembly head.

Parameters:
BOOL b

Specifies the state of the assembly head.

If TRUE the assembly head is opened.

If FALSE the assembly head is closed.

virtual BOOL IsAssemblyMember ( ) const
pure virtual
Remarks
Method to determine membership in an assembly. It will work with either open or closed members.

Returns
If TRUE, node is a member the assembly.

If FALSE, node is not a member of the assembly.

virtual BOOL IsAssemblyHead ( ) const
pure virtual
Remarks
Method to determine if a node is an assembly head. It works with either open or closed heads.

Returns
If TRUE, node is an assembly head.

If FALSE, node is not an assembly head.

virtual BOOL IsAssemblyMemberOpen ( ) const
pure virtual
Remarks
Method to determine if an assembly member is open.

Returns
If TRUE, the assembly member is open.

If FALSE, the assembly member is not open.

virtual BOOL IsAssemblyHeadOpen ( ) const
pure virtual
Remarks
Method to determine if an assembly head is open.

Returns
If TRUE, the assembly head is open.

If FALSE, the assembly head is not open.

virtual BOOL IsAssemblyHeadMemberOf ( const IAssembly *const  assemblyHead) const
pure virtual
Remarks
Method to detect assemblies within assemblies. It checks whether this assembly node is a head node and is also a member of the assembly headed by the node passed in as a parameter.

Returns
If TRUE, node is both a head node and is a member of another assembly.

If FALSE, node is neither a head node nor a member of another assembly.

virtual void SetAssemblyBBoxDisplay ( BOOL  b)
pure virtual

Methods to control the display of an assembly's world space bounding box.

Parameters
b- If TRUE, display the bounding box. If FALSE, do not display the bounding box.
virtual BOOL GetAssemblyBBoxDisplay ( )
pure virtual

Method to retrieve the value of the bounding box display flag.

Returns
- If TRUE, the bounding box display is enabled. If FALSE, the bounding box display is disabled.
virtual IOResult Save ( ISave isave)
pure virtual
Remarks
Write method for implementing persistence of the underlying object.

Parameters:
ISave* isave

Pointer for write methods.

Returns
IO_OK, the call succeeded.

IO_ERROR, the call was unsuccessful.

virtual IOResult Load ( ILoad iload)
pure virtual
Remarks
Read method for implementing persistence of the underlying object.

Parameters:
ILoad* iload

Pointer for read methods.

Returns
IO_OK, the call succeeded.

IO_ERROR, the call was unsuccessful.