Detailed Description

See also:: Class FPStaticInterface, Class Control, Class ReferenceTarget

Description:

This class is available in release 4.0 and later only.

This class represents the interface that provides general access to the parameter wiring functions. You can obtain a pointer to the Parameter Wire Manager interface using;

    IParamWireMgr* GetParamWireMgr();

. This macro will return

    static_cast<IParamWireMgr*>(GetCOREInterface(PARAMWIRE_MGR_INTERFACE));

All methods of this class are Implemented by the System.

#include <iparamwire.h>

Inheritance diagram for IParamWireMgr:

[legend]

List of all members.

Public Types
enum	{ startParamWire, openEditor, editParams, editParam, editControllers, editController, connect, connect2Way, disconnect, disconnect2Way }
Public Member Functions
virtual void	StartParamWire ()=0
virtual void	OpenEditor ()=0
virtual void	EditParams (ReferenceTarget leftParent, int leftSubNum, ReferenceTarget rightParent, int rightSubNum)=0
virtual void	EditParam (ReferenceTarget *parent, int subNum)=0
virtual void	EditControllers (Control leftWire, Control rightWire)=0
virtual void	EditController (Control *wire)=0
virtual bool	Connect (ReferenceTarget fromParent, int fromSubNum, ReferenceTarget toParent, int toSubNum, MCHAR *toExpr)=0
virtual bool	Connect2Way (ReferenceTarget leftParent, int leftSubNum, ReferenceTarget rightParent, int rightSubNum, MCHAR leftExpr, MCHAR rightExpr=NULL)=0
virtual bool	Disconnect (Control *wireController)=0
virtual bool	Disconnect2Way (Control wireController1, Control wireController2)=0
virtual Animatable *	ParamWireMenu (ReferenceTarget pTarget, int iSubNum, int iFlags=PWMF_LEFT_TARGET, HWND hWnd=NULL, IPoint2 pPt=NULL)=0

Member Enumeration Documentation

anonymous enum

Search for all occurrences

Enumerator:

startParamWire	Search for all occurrences
openEditor	Search for all occurrences
editParams	Search for all occurrences
editParam	Search for all occurrences
editControllers	Search for all occurrences
editController	Search for all occurrences
connect	Search for all occurrences
connect2Way	Search for all occurrences
disconnect	Search for all occurrences
disconnect2Way	Search for all occurrences

         { startParamWire,
           openEditor,
           editParams, editParam,
           editControllers, editController,
           connect, connect2Way,
           disconnect, disconnect2Way
        };

Member Function Documentation

virtual void StartParamWire ( ) [pure virtual]

Search for all occurrences

Remarks:: This method will launch the parameter wiring UI mode.

virtual void OpenEditor ( ) [pure virtual]

Search for all occurrences

Remarks:: This method will open up the parameter wiring dialog on the selected objects.

virtual void EditParams	(	ReferenceTarget *	leftParent,
		int	leftSubNum,
		ReferenceTarget *	rightParent,
		int	rightSubNum
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method allows you to edit the left- and right-hand parameters and opens the parameter wiring dialog using the provided parameters.

Parameters:

leftParent	- A pointer to the left-hand reference target.
leftSubNum	- The sub-animatable of the left-hand reference target.
rightParent	- A pointer to the right-hand reference target.
rightSubNum	- The sub-animatable of the right-hand reference target.

virtual void EditParam	(	ReferenceTarget *	parent,
		int	subNum
	)		`[pure virtual]`

Search for all occurrences

virtual void EditControllers	(	Control *	leftWire,
		Control *	rightWire
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method allows you to setup the two controllers for the left- and right-hand to edit.

Parameters:

leftWire	- A pointer to the controller for the left-hand wire.
rightWire	- A pointer to the controller for the right-hand wire.

virtual void EditController ( Control * wire ) [pure virtual]

Search for all occurrences

Remarks:: This method is identical to the EditControllers() but accepts a single wire controller for the left-hand. This method effectively calls EditControllers(wire, NULL).

Parameters:

wire	- A pointer to the controller being edited.

virtual bool Connect	(	ReferenceTarget *	fromParent,
		int	fromSubNum,
		ReferenceTarget *	toParent,
		int	toSubNum,
		MCHAR *	toExpr
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method allows you to set up a one-way wire.

Parameters:

fromParent	- A pointer to the reference target to wire from.
fromSubNum	- The sub-animatable to wire from.
toParent	- A pointer to the reference target to wire to.
toSubNum	- The sub-animatable to wire to.
toExpr	- A string containing the expression on the "to wire".

Returns:: TRUE if the connection can be made, otherwise FALSE.

virtual bool Connect2Way	(	ReferenceTarget *	leftParent,
		int	leftSubNum,
		ReferenceTarget *	rightParent,
		int	rightSubNum,
		MCHAR *	leftExpr,
		MCHAR *	rightExpr = `NULL`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method allows you to set up a two-way wire.

Parameters:

leftParent	- A pointer to the left-hand reference target.
leftSubNum	- The sub-animatable of the left-hand reference target.
rightParent	- A pointer to the right-hand reference target.
rightSubNum	- The sub-animatable of the right-hand reference target.
leftExpr	- A string containing the expression for the left-hand target.
rightExpr	= NULL - A string containing the expression for the right-hand target.

Returns:: TRUE if the connection can be made, otherwise FALSE.

virtual bool Disconnect ( Control * wireController ) [pure virtual]

Search for all occurrences

Remarks:: This method allows you to disconnect a one-way wire.

Parameters:

wireController - A pointer to the wire controller you wish to disconnect.

Returns:: TRUE if the disconnect was successful, otherwise FALSE.

virtual bool Disconnect2Way	(	Control *	wireController1,
		Control *	wireController2
	)		`[pure virtual]`

Search for all occurrences

Remarks:: This method allows you to disconnect a two-way wire.

Parameters:

wireController1	- A pointer to the first wire controller you wish to disconnect.
wireController2	- A pointer to the second wire controller you wish to disconnect.

Returns:: TRUE if the disconnect was successful, otherwise FALSE.

virtual Animatable* ParamWireMenu	(	ReferenceTarget *	pTarget,
		int	iSubNum,
		int	iFlags = `PWMF_LEFT_TARGET`,
		HWND	hWnd = `NULL`,
		IPoint2 *	pPt = `NULL`
	)		`[pure virtual]`

Search for all occurrences

Remarks:: The ParamWireMenu method allows a plugin to host the parameter wiring context menus, typically found in the viewport, into any window.

Parameters:

pTarget	- The parent of the target animatable that the context menu will be derived from. pTarget should support the I_WIRECONTROL interface.
iSubNum	- The SubAnim number in pTarget of the target animatable that the context menu will be derived from. If iSubNum is negative, pTarget will be used.
iFlags	- one of the parameter wire flags. This sets which which action to take.
hWnd	- used as the parent window for the context menus and parameter wiring dialog.
pPt	- If iFlags is not PWMF_HAS_MENU, pPt should specify the position of the context menu in screen coordinates

Returns:: The animatable that derived the context menu, or NULL if no menu was displayed

IParamWireMgr Class Reference

Detailed Description

Public Types

Public Member Functions

Member Enumeration Documentation

Member Function Documentation