IBaseWireControl Class Reference

Search for all occurrences

---

Detailed Description

See also:

Class Control, Class StdControl, Class FPMixinInterface

Description:

This class is available in release 4.0 and later only.

This class represents the interface for individual wire controllers. You can obtain a pointer to the Base Wire control interface using;

    IBaseWireControl* GetWireControlInterface(Animatable* a);

This macro will return

    (IBaseWireControl*)a-\>GetInterface(WIRE_CONTROLLER_INTERFACE);

The Class ID's of individual wire controllers are: FLOAT_WIRE_CONTROL_CLASS_ID
POSITION_WIRE_CONTROL_CLASS_ID
POINT3_WIRE_CONTROL_CLASS_ID
ROTATION_WIRE_CONTROL_CLASS_ID
SCALE_WIRE_CONTROL_CLASS_ID

All methods of this class are Implemented by the System.

#include <iparamwire.h>

Inheritance diagram for IBaseWireControl:

List of all members.

Public Types
enum	{   getNumWires, getWireParent, getWireSubnum, getCoController,   getExprText, setExprText, getSlaveAnimation, setSlaveAnimation,   isMaster, isSlave, isTwoWay }
Public Member Functions
virtual int	get_num_wires ()=0
virtual Animatable *	get_wire_parent (int i)=0
virtual int	get_wire_subnum (int i)=0
virtual Control *	get_co_controller (int i)=0
virtual MCHAR *	get_expr_text (int i)=0
virtual void	set_expr_text (int i, MCHAR *text)=0
virtual void	set_slave_animation (Control *c)=0
virtual Control *	get_slave_animation ()=0
virtual bool	is_master ()=0
virtual bool	is_slave ()=0
virtual bool	is_two_way ()=0
virtual void	transfer_parent (ReferenceTarget *oldp, ReferenceTarget *newp)=0
virtual void	transfer_subnum (short oldn, short newn)=0
FPInterfaceDesc *	GetDesc ()
BEGIN_FUNCTION_MAP	FN_1 (getWireParent, TYPE_REFTARG, get_wire_parent, TYPE_INDEX)
	FN_1 (getWireSubnum, TYPE_INDEX, get_wire_subnum, TYPE_INDEX)
	FN_1 (getCoController, TYPE_CONTROL, get_co_controller, TYPE_INDEX)
	FN_1 (getExprText, TYPE_STRING, get_expr_text, TYPE_INDEX)
	VFN_2 (setExprText, set_expr_text, TYPE_INDEX, TYPE_STRING)
	RO_PROP_FN (getNumWires, get_num_wires, TYPE_INT)
	RO_PROP_FN (isMaster, is_master, TYPE_bool)
	RO_PROP_FN (isSlave, is_slave, TYPE_bool)
	RO_PROP_FN (isTwoWay, is_two_way, TYPE_bool)
	PROP_FNS (getSlaveAnimation, get_slave_animation, setSlaveAnimation, set_slave_animation, TYPE_CONTROL)

---

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

getNumWires	Search for all occurrences
getWireParent	Search for all occurrences
getWireSubnum	Search for all occurrences
getCoController	Search for all occurrences
getExprText	Search for all occurrences
setExprText	Search for all occurrences
getSlaveAnimation	Search for all occurrences
setSlaveAnimation	Search for all occurrences
isMaster	Search for all occurrences
isSlave	Search for all occurrences
isTwoWay	Search for all occurrences

             { getNumWires, getWireParent, getWireSubnum, getCoController, 
               getExprText, setExprText, 
               getSlaveAnimation, setSlaveAnimation, isMaster, isSlave, isTwoWay, };

---

Member Function Documentation

virtual int get_num_wires

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns the number of wires out of this controller (i.e. the number of dependent params).

virtual Animatable* get_wire_parent

(

int

i

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns a pointer to the i-th dependent parameter parent.

Parameters:

i	- The index you wish to retrieve.

virtual int get_wire_subnum

(

int

i

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns the i-th dependent parameter subanim num in the animatable. param i - The index of the subanim.

virtual Control* get_co_controller

(

int

i

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns a pointer to the i-th CoController.

Parameters:

i	- The index of the controller.

virtual MCHAR* get_expr_text

(

int

i

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns the expression string of the i-th wire parameter. param i - The index of the parameter.

virtual void set_expr_text	(	int	i,
		MCHAR *	text
	)		[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the expression string of the i-th wire parameter.

Parameters:

i	- The index of the parameter
text	- The expression you wish to set.

virtual void set_slave_animation

(

Control *

c

)

[pure virtual]

Search for all occurrences

Remarks:

This method allows you to set the slave animation controller.

Parameters:

c	- A pointer to the controller you wish to set.

virtual Control* get_slave_animation

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method returns a pointer to the slave animation controller.

virtual bool is_master

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method will return TRUE if the wire is a master predicate, otherwise it will return FALSE.

virtual bool is_slave

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method will return TRUE if the wire is a slave predicate, otherwise it will return FALSE.

virtual bool is_two_way

(

)

[pure virtual]

Search for all occurrences

Remarks:

This method will return TRUE if the wire is a two-way predicate, otherwise it will return FALSE.

virtual void transfer_parent	(	ReferenceTarget *	oldp,
		ReferenceTarget *	newp
	)		[pure virtual]

Search for all occurrences

virtual void transfer_subnum	(	short	oldn,
		short	newn
	)		[pure virtual]

Search for all occurrences

FPInterfaceDesc* GetDesc

(

)

[inline, virtual]

Search for all occurrences

Remarks:

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

Implements FPInterface.

{ return GetDescByID(WIRE_CONTROLLER_INTERFACE); }

BEGIN_FUNCTION_MAP FN_1	(	getWireParent	,
		TYPE_REFTARG	,
		get_wire_parent	,
		TYPE_INDEX
	)

Search for all occurrences

FN_1	(	getWireSubnum	,
		TYPE_INDEX	,
		get_wire_subnum	,
		TYPE_INDEX
	)

Search for all occurrences

FN_1	(	getCoController	,
		TYPE_CONTROL	,
		get_co_controller	,
		TYPE_INDEX
	)

Search for all occurrences

FN_1	(	getExprText	,
		TYPE_STRING	,
		get_expr_text	,
		TYPE_INDEX
	)

Search for all occurrences

VFN_2	(	setExprText	,
		set_expr_text	,
		TYPE_INDEX	,
		TYPE_STRING
	)

Search for all occurrences

RO_PROP_FN	(	getNumWires	,
		get_num_wires	,
		TYPE_INT
	)

Search for all occurrences

RO_PROP_FN	(	isMaster	,
		is_master	,
		TYPE_bool
	)

Search for all occurrences

RO_PROP_FN	(	isSlave	,
		is_slave	,
		TYPE_bool
	)

Search for all occurrences

RO_PROP_FN	(	isTwoWay	,
		is_two_way	,
		TYPE_bool
	)

Search for all occurrences

PROP_FNS	(	getSlaveAnimation	,
		get_slave_animation	,
		setSlaveAnimation	,
		set_slave_animation	,
		TYPE_CONTROL
	)

Search for all occurrences