IAssembly Class Reference
 
 
 
IAssembly Class Reference

#include <iassembly.h>

Inheritance diagram for IAssembly:
FPMixinInterface FPInterface BaseInterface InterfaceServer MaxHeapOperators IAssembly2

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);

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 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.
virtual BOOL  GetAssemblyBBoxDisplay ()=0
  Method to retrieve the value of the bounding box display flag.
virtual IOResult  Save (ISave *isave)=0
virtual IOResult  Load (ILoad *iload)=0

Member Enumeration Documentation


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.

Implemented in IAssembly2.

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.

Implemented in IAssembly2.

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.