Class IAssembly : public FPMixinInterface

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

Methods:

Notes for Set methods:

Nodes can be both assembly members and heads at the same time.

Prototype

virtual void SetAssemblyMember(BOOL b) = 0;

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.

Prototype

virtual void SetAssemblyMemberOpen(BOOL b) = 0;

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.

Prototype:

virtual void SetAssemblyHead(BOOL b) = 0;

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.

Prototype:

virtual void SetAssemblyHeadOpen(BOOL b) = 0;

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.

Notes for Query methods:

To detect closed assembly members or assembly heads, check both the member/head flag and the open member/head flag i.e. IsAssemblyHead() && !IsAssemblyMemberOpen().

Prototype:

virtual BOOL IsAssemblyMember() const = 0;

Remarks:

Method to determine membership in an assembly. It will work with either open or closed members.

Return Value:

If TRUE, node is a member the assembly.

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

Prototype:

virtual BOOL IsAssemblyHead() const = 0;

Remarks:

Method to determine if a node is an assembly head. It works with either open or closed heads.

Return Value:

If TRUE, node is an assembly head.

If FALSE, node is not an assembly head.

Prototype:

virtual BOOL IsAssemblyMemberOpen() const = 0;

Remarks:

Method to determine if an assembly member is open.

Return Value:

If TRUE, the assembly member is open.

If FALSE, the assembly member is not open.

Prototype:

virtual BOOL IsAssemblyHeadOpen() const = 0;

Remarks:

Method to determine if an assembly head is open.

Return Value:

If TRUE, the assembly head is open.

If FALSE, the assembly head is not open.

Prototype:

virtual BOOL IsAssemblyHeadMemberOf(const IAssembly* const assemblyHead) const = 0;

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.

Return Value:

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.

Prototype:

virtual IOResult Save(ISave* isave) = 0;

Remarks:

Write method for implementing persistence of the underlying object.

Parameters:

ISave* isave

Pointer for write methods.

Return Value:

IO_OK, the call succeeded.

IO_ERROR, the call was unsuccessful.

Prototype:

virtual IOResult Load(ILoad* iload) = 0;

Remarks:

Read method for implementing persistence of the underlying object.

Parameters:

ILoad* iload

Pointer for read methods.

Return Value:

IO_OK, the call succeeded.

IO_ERROR, the call was unsuccessful.