IPosConstPosition Class Reference

This reference page is linked to from the following overview topics: Function Publishing Example.

---

Search for all occurrences

---

Detailed Description

See also:

Class Control, Class FPMixinInterface.

Description:

This class is available in release 4.0 and later only.

This class represents the interface to the Position Constraint. You can obtain a pointer to the position constraint interface using; GetIPosConstInterface(cd). This macro will return

(IPosConstPosition*)(CD)->GetFPInterface(POS_CONSTRAINT_INTERFACE).

POSPOS_PBLOCK_REF may be used to access the position constraint controller's references:

All methods of this class are Implemented by the System.

#include <istdplug.h>

Inheritance diagram for IPosConstPosition:

List of all members.

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

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

get_num_targets	Search for all occurrences
get_node	Search for all occurrences
get_target_weight	Search for all occurrences
set_target_weight	Search for all occurrences
append_target	Search for all occurrences
delete_target	Search for all occurrences

             {  get_num_targets,        get_node,           get_target_weight,      
                set_target_weight,      append_target,      delete_target,};

---

Member Function Documentation

BEGIN_FUNCTION_MAP FN_0	(	get_num_targets	,
		TYPE_INT	,
		GetNumTargets
	)

Search for all occurrences

FN_1	(	get_node	,
		TYPE_INODE	,
		GetNode	,
		TYPE_INDEX
	)

Search for all occurrences

FN_1	(	get_target_weight	,
		TYPE_FLOAT	,
		GetTargetWeight	,
		TYPE_INDEX
	)

Search for all occurrences

FN_2	(	set_target_weight	,
		TYPE_BOOL	,
		SetTargetWeight	,
		TYPE_INDEX	,
		TYPE_FLOAT
	)

Search for all occurrences

FN_2	(	append_target	,
		TYPE_BOOL	,
		AppendTarget	,
		TYPE_INODE	,
		TYPE_FLOAT
	)

Search for all occurrences

FN_1	(	delete_target	,
		TYPE_BOOL	,
		DeleteTarget	,
		TYPE_INDEX
	)

Search for all occurrences

END_FUNCTION_MAP FPInterfaceDesc* GetDesc

(

)

[virtual]

Search for all occurrences

Remarks:

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

virtual int GetNumTargets

(

)

[pure virtual]

Search for all occurrences

Remarks:

Returns the number of target nodes in the position target list.

virtual INode* GetNode

(

int

targetNumber

)

[pure virtual]

Search for all occurrences

Remarks:

Gets one of the position nodes that the position constraint controller targets, specified by targetNumber.

Parameters:

int targetNumber

The node number in the position target list to be obtained.

virtual float GetTargetWeight

(

int

targetNumber

)

[pure virtual]

Search for all occurrences

Remarks:

Gets the weight of one of the position nodes that the position constraint controller targets, specified by targetNumber.

Parameters:

int targetNumber

The node number in the position target list to set.

Returns:

Returns the position target weight if the targetNumber is relevant, 0.0f otherwise.

virtual BOOL SetTargetWeight	(	int	targetNumber,
		float	weight
	)		[pure virtual]

Search for all occurrences

Remarks:

Sets the weight of one of the position nodes that the position constraint controller follows, specified by targetNumber.

Parameters:

int targetNumber

The node number in the position target list whose weight is to be set.

float weight

The weight to set.

Returns:

TRUE if there is more than one position target in the list and you are trying to set weight, FALSE otherwise.

virtual BOOL AppendTarget	(	INode *	target,
		float	weight = 50.0
	)		[pure virtual]

Search for all occurrences

Remarks:

Appends the current position target list by one and appends.

Parameters:

INode *target

The node that is to be appended to the current position target list.

float weight=50.0

This is the weight that is to be assigned to the newly appended position target. The default weight is 50.0.

Returns:

TRUE if the target was appended, otherwise FALSE.

virtual BOOL DeleteTarget

(

int

selection

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to delete a specified target.

Parameters:

int selection

The node number in the position target list to delete.

Returns:

TRUE if successful, otherwise FALSE.