#include <iparamwire.h>

Class Description

See also: Class FPStaticInterface, Class Control, Class ReferenceTarget

Description:: 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.

Inheritance diagram for IParamWireMgr:

Public Types
enum	{ startParamWire, openEditor, editParams, editParam, editControllers, editController, connect, connect2Way, disconnect, disconnect2Way }

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

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, const MCHAR *toExpr)=0

virtual bool	Connect2Way (ReferenceTarget leftParent, int leftSubNum, ReferenceTarget rightParent, int rightSubNum, const MCHAR leftExpr, const 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

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Enumeration Documentation

anonymous enum

Enumerator
startParamWire
openEditor
editParams
editParam
editControllers
editController
connect
connect2Way
disconnect
disconnect2Way

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

Member Function Documentation

virtual void StartParamWire ( )

pure virtual

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

virtual void OpenEditor ( )

pure virtual

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

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

virtual void EditControllers	(	Control *	leftWire,
		Control *	rightWire
	)

pure virtual

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

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,
		const MCHAR *	toExpr
	)

pure virtual

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,
		const MCHAR *	leftExpr,
		const MCHAR *	rightExpr = `NULL`
	)

pure virtual

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

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

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

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

Class Description

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation