Detailed Description
- See also:
- Class Control,
Class FPMixinInterface.
- Description:
- This class is available in release 4.0 and later only.
This class is an interface to the LookAt Constraint rotation controller. You can obtain a pointer to the list control interface using; GetILookAtConstInterface(cd). This macro will return (ILookAtConstRotation*)(CD)->GetFPInterface(LOOKAT_CONSTRAINT_INTERFACE).
LOOKAT_ROT_PBLOCK_REF may be used to access the look-at controller's references:
All methods of this class are Implemented by the System.
#include <istdplug.h>
Inheritance diagram for
ILookAtConstRotation:
Public Types |
|
| enum | { get_num_targets, get_node, get_target_weight, set_target_weight, append_target, delete_target } |
Public Member Functions |
|
| BEGIN_FUNCTION_MAP | FN_0 (get_num_targets, TYPE_INT, GetNumTargets) |
| FN_1 (get_node, TYPE_INODE, GetNode, TYPE_INDEX) | |
| FN_1 (get_target_weight, TYPE_FLOAT, GetTargetWeight, TYPE_INDEX) | |
| FN_2 (set_target_weight, TYPE_BOOL, SetTargetWeight, TYPE_INDEX, TYPE_FLOAT) | |
| FN_2 (append_target, TYPE_BOOL, AppendTarget, TYPE_INODE, TYPE_FLOAT) | |
| FN_1 (delete_target, TYPE_BOOL, DeleteTarget, TYPE_INDEX) | |
| END_FUNCTION_MAP FPInterfaceDesc * | GetDesc () |
| virtual int | GetNumTargets ()=0 |
| virtual INode * | GetNode (int targetNumber)=0 |
| virtual float | GetTargetWeight (int targetNumber)=0 |
| virtual BOOL | SetTargetWeight (int targetNumber, float weight)=0 |
| virtual BOOL | AppendTarget (INode *target, float weight=50.0)=0 |
| virtual BOOL | DeleteTarget (int selection)=0 |
| virtual BOOL | GetRelative ()=0 |
| virtual BOOL | GetVLisAbs ()=0 |
| virtual BOOL | GetUpnodeWorld ()=0 |
| virtual BOOL | GetStoUPAxisFlip ()=0 |
| virtual BOOL | GetTargetAxisFlip ()=0 |
| virtual BOOL | Get_SetOrientation ()=0 |
| virtual int | GetTargetAxis ()=0 |
| virtual int | GetUpNodeAxis ()=0 |
| virtual int | Get_StoUPAxis ()=0 |
| virtual int | Get_upnode_control ()=0 |
| virtual void | SetRelative (BOOL rel)=0 |
| virtual void | SetVLisAbs (BOOL rel)=0 |
| virtual void | SetUpnodeWorld (BOOL uw)=0 |
| virtual void | SetTargetAxisFlip (BOOL rel)=0 |
| virtual void | SetStoUPAxisFlip (BOOL rel)=0 |
| virtual void | Set_SetOrientation (BOOL rel)=0 |
| virtual void | Set_Reset_Orientation ()=0 |
| virtual void | SetTargetAxis (int axis)=0 |
| virtual void | SetUpNodeAxis (int axis)=0 |
| virtual void | Set_StoUPAxis (int axis)=0 |
Member Enumeration Documentation
| anonymous enum |
Member Function Documentation
| BEGIN_FUNCTION_MAP FN_0 | ( | get_num_targets | , |
| TYPE_INT | , | ||
| GetNumTargets | |||
| ) |
| FN_1 | ( | get_node | , |
| TYPE_INODE | , | ||
| GetNode | , | ||
| TYPE_INDEX | |||
| ) |
| FN_1 | ( | get_target_weight | , |
| TYPE_FLOAT | , | ||
| GetTargetWeight | , | ||
| TYPE_INDEX | |||
| ) |
| FN_2 | ( | set_target_weight | , |
| TYPE_BOOL | , | ||
| SetTargetWeight | , | ||
| TYPE_INDEX | , | ||
| TYPE_FLOAT | |||
| ) |
| FN_2 | ( | append_target | , |
| TYPE_BOOL | , | ||
| AppendTarget | , | ||
| TYPE_INODE | , | ||
| TYPE_FLOAT | |||
| ) |
| FN_1 | ( | delete_target | , |
| TYPE_BOOL | , | ||
| DeleteTarget | , | ||
| TYPE_INDEX | |||
| ) |
| END_FUNCTION_MAP FPInterfaceDesc* GetDesc | ( | ) | [virtual] |
- Remarks:
- Returns a pointer to the class which contains the interface metadata.
Implements FPInterface.
| virtual int GetNumTargets | ( | ) | [pure virtual] |
- Remarks:
- Returns the number of nodes in the list of nodes to look at.
| virtual INode* GetNode | ( | int | targetNumber | ) | [pure virtual] |
| virtual float GetTargetWeight | ( | int | targetNumber | ) | [pure virtual] |
- Remarks:
- Gets the weight of one of the Look-At nodes that the Look-At constraint controller targets, specified by targetNumber.
- Parameters:
- int targetNumber
The node number in the Look-At target list whose weight is to be obtained.
| virtual BOOL SetTargetWeight | ( | int | targetNumber, |
| float | weight | ||
| ) | [pure virtual] |
- Remarks:
- Sets the weight of one of the Look-At nodes that the Look-At constraint controller follows, specified by targetNumber.
- Parameters:
- targetNumber
The node number in the Look-At target list whose weight is to be set. float weight
The weight to set.
- Returns:
- TRUE if there is more than one Look-At targets in the list and you are trying to set weight, FALSE otherwise.
| virtual BOOL AppendTarget | ( | INode * | target, |
| float | weight =
50.0 |
||
| ) | [pure virtual] |
- Remarks:
- Appends the current Look-At target list by one and appends the current Look-At target weightlist by one.
- Parameters:
- INode
*target
The node that is to be appended to the current Look-At target list.
float weight=50.0
This is the weight that is to be assigned to the newly appended Look-At target. The default weight is 50.0.
- Returns:
- TRUE if the target was appended, otherwise FALSE.
| virtual BOOL DeleteTarget | ( | int | selection | ) | [pure virtual] |
- Remarks:
- This method allows you to delete a specified target.
- Parameters:
- int selection
The zero based node number in the list of nodes the controller looks at.
| virtual BOOL GetRelative | ( | ) | [pure virtual] |
- Remarks:
- Gets the relative/absolute mode corresponding to the "Keep Initial Offset" checkbox in the UI.
| virtual BOOL GetVLisAbs | ( | ) | [pure virtual] |
- Remarks:
- Gets the ViewLine relative/absolute mode corresponding to the "Keep ViewLine Length Absolute" checkbox in the UI. When Viewline Length is absolute, the "ViewLine Length" spinner sets the length of the ViewLine. A negative length implies that starting from the source object the line travels opposite to the direction of the target object. The source/target distance has no effect on the ViewLine length in this mode. If the "Keep ViewLine Length Absolute" checkbox is unchecked, the ViewLine length is determined from the spinner value, which is interpreted as a percentage of the source/target distance.
- Returns:
- TRUE if the ViewLine length is absolute, FALSE otherwise.
| virtual BOOL GetUpnodeWorld | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the "World" checkbox is on; FALSE if off.
| virtual BOOL GetStoUPAxisFlip | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the "selected" axis flip checkbox is on; FALSE if off.
| virtual BOOL GetTargetAxisFlip | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the "source" axis flip checkbox is on; FALSE if off.
| virtual BOOL Get_SetOrientation | ( | ) | [pure virtual] |
- Remarks:
- Returns TRUE if the orientation flag is set, FALSE if off.
| virtual int GetTargetAxis | ( | ) | [pure virtual] |
- Remarks:
- Gets the selection corresponding to the "Select LookAt Axis" button in the UI. Obtains which of the source axes is required to coincide with the target axis.
- Returns:
- (0) if the target axis coincides with the x axis of the source object. (1) if the target axis coincides with the y axis of the source object. (2) if the target axis coincides with the z axis of the source object.
| virtual int GetUpNodeAxis | ( | ) | [pure virtual] |
- Remarks:
- Gets the selection corresponding to the "Source/Upnode Alignment: Aligned to UpNode Axis:" radiobutton in the UI. Obtains which of the upnode axes is required to align with a specified source axis.
- Returns:
- (0) if the upnode x axis coincides with a specified source object. (1) if the upnode y axis coincides with a specified source object. (2) if the upnode z axis coincides with a specified source object.
| virtual int Get_StoUPAxis | ( | ) | [pure virtual] |
- Remarks:
- Gets the selection corresponding to the "Source/Upnode Alignment: Aligned to UpNode Axis:" radiobutton in the UI. Obtains which of the source axes is required to align with a specified upnode axis.
- Returns:
- (0) if the source x axis coincides with a specified upnode axis. (1) if the source y axis coincides with a specified upnode axis. (2) if the source z axis coincides with a specified upnode axis.
| virtual int Get_upnode_control | ( | ) | [pure virtual] |
| virtual void SetRelative | ( | BOOL | rel | ) | [pure virtual] |
- Remarks:
- This method allows you to set the "relative" flag.
- Parameters:
- BOOL rel
TRUE to set the relative flag, otherwise FALSE.
| virtual void SetVLisAbs | ( | BOOL | rel | ) | [pure virtual] |
- Remarks:
- Sets the relative/absolute mode corresponding to the "Keep ViewLine Length Absolute" checkbox in the UI.
- Parameters:
- BOOL rel
TRUE if "Keep ViewLine Length Absolute" is active (checked), FALSE otherwise.
| virtual void SetUpnodeWorld | ( | BOOL | uw | ) | [pure virtual] |
- Remarks:
- This method allows you to set the "World" flag.
- Parameters:
- BOOL uw
TRUE to set the world flag, otherwise false.
| virtual void SetTargetAxisFlip | ( | BOOL | rel | ) | [pure virtual] |
- Remarks:
- This method allows you to set the "source" flip axis flag.
- Parameters:
- BOOL rel
TRUE to set the source flip axis flag, otherwise FALSE.
| virtual void SetStoUPAxisFlip | ( | BOOL | rel | ) | [pure virtual] |
- Remarks:
- This method allows you to set the "selected" axis flip flag.
- Parameters:
- BOOL rel
TRUE to set the selected axis flip flag, otherwise FALSE.
| virtual void Set_SetOrientation | ( | BOOL | rel | ) | [pure virtual] |
- Remarks:
- This method allows you to set the orientation flag.
- Parameters:
- BOOL rel
TRUE to set the orientation flag, otherwise FALSE.
| virtual void Set_Reset_Orientation | ( | ) | [pure virtual] |
- Remarks:
- Resets to zero the amount of orientation offset, effected through the "Set Orientation" feature.
| virtual void SetTargetAxis | ( | int | axis | ) | [pure virtual] |
- Remarks:
- Sets the selection corresponding to the "Set Orientation" button in the UI. Specifies which of the source axes is required to coincide with the target axis.
- Parameters:
- int axis
(0) if TargetAxis coincides with the X axis of the source object. (1) if TargetAxis coincides with the Y axis of the source object. (2) if TargetAxis coincides with the Z axis of the source object
| virtual void SetUpNodeAxis | ( | int | axis | ) | [pure virtual] |
- Remarks:
- Sets the selection corresponding to the "Source/Upnode Alignment: Aligned to UpNode Axis:" radiobutton in the UI. Specifies which of the upnode axes is required to align with a specified source axis.
- Parameters:
- int axis
(0) if the upnode X axis coincides with a specified source axis. (1) if the upnode Y axis coincides with a specified source axis. (2) if the upnode Z axis coincides with a specified source axis.
| virtual void Set_StoUPAxis | ( | int | axis | ) | [pure virtual] |
- Remarks:
- Sets the selection corresponding to the "Source/Upnode Alignment: Aligned to UpNode Axis:" radiobutton in the UI. Specifies which of the source axes is required to align with a specified upnode axis.
- Parameters:
- int axis
(0) if the source X axis coincides with a specified upnode axis. (1) if the source Y axis coincides with a specified upnode axis. (2) if the source Z axis coincides with a specified upnode axis.
