Detailed Description
IAttachCtrl is an interface for getting/setting properties on the Attach controller.
The interface is returned by calling GetInterface(I_ATTACHCTRL).
#include <istdplug.h>
Inheritance diagram for IAttachCtrl:
Public Member Functions |
|
| virtual BOOL | SetObject (INode *node)=0 |
| Set the Node to attach to. |
|
| virtual INode * | GetObject ()=0 |
| Get the Node to attached to. |
|
| virtual AKey * | GetKey (int index)=0 |
| Get a Attach controller key. |
|
| virtual void | SetKeyPos (TimeValue t, DWORD faceIndex, Point3 bary)=0 |
| Set a attach controller key, creating the
key if necessary. |
|
| virtual BOOL | GetAlign ()=0 |
| Get Attach controller Align property.
|
|
| virtual void | SetAlign (BOOL align)=0 |
| Set Attach controller Align property.
|
|
| virtual BOOL | GetManualUpdate ()=0 |
| Get Attach controller Manual Update
property. |
|
| virtual void | SetManualUpdate (BOOL manUpdate)=0 |
| Set Attach controller Manual Update
property. |
|
| virtual void | Invalidate (BOOL forceUpdate=FALSE)=0 |
| Invalidate the Attach controller and update
its ui if displayed. |
|
Member Function Documentation
| virtual BOOL SetObject | ( | INode * | node | ) | [pure virtual] |
Set the Node to attach to.
- Parameters:
-
[in] node The Node to attach to
- Returns:
- True if the node could be set as the attached to node
| virtual INode* GetObject | ( | ) | [pure virtual] |
| virtual AKey* GetKey | ( | int | index | ) | [pure virtual] |
Get a Attach controller key.
- Parameters:
-
[in] index The key index
- Returns:
- The indexed Attach controller key, NULL if index invalid
| virtual void SetKeyPos | ( | TimeValue | t, |
| DWORD | faceIndex, | ||
| Point3 | bary | ||
| ) | [pure virtual] |
Set a attach controller key, creating the key if necessary.
- Parameters:
-
[in] t The time of the key [in] faceIndex The face index on the node's mesh to attach to [in] bary The barycentric coordinates on the face
| virtual BOOL GetAlign | ( | ) | [pure virtual] |
| virtual void SetAlign | ( | BOOL | align | ) | [pure virtual] |
Set Attach controller Align property.
- Parameters:
-
[in] align New Align state
| virtual BOOL GetManualUpdate | ( | ) | [pure virtual] |
Get Attach controller Manual Update property.
- Returns:
- The Manual Update state
| virtual void SetManualUpdate | ( | BOOL | manUpdate | ) | [pure virtual] |
Set Attach controller Manual Update property.
- Parameters:
-
[in] manUpdate New Manual Update state
| virtual void Invalidate | ( | BOOL | forceUpdate =
FALSE |
) | [pure virtual] |
Invalidate the Attach controller and update its ui if displayed.
- Parameters:
-
[in] forceUpdate If true, forces an update of the controller even if manual update is off.
