IParamWireMgr Class Reference
 
 
 
IParamWireMgr Class Reference

#include <iparamwire.h>

Inheritance diagram for IParamWireMgr:
FPStaticInterface FPInterfaceDesc FPInterface BaseInterface InterfaceServer MaxHeapOperators

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; . This macro will return All methods of this class are Implemented by the System.

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, const MCHAR *toExpr)=0
virtual bool  Connect (ReferenceTarget *fromParent, int fromSubNum, ReferenceTarget *toParent, int toSubNum, MCHAR *toExpr) sealed
virtual bool  Connect2Way (ReferenceTarget *leftParent, int leftSubNum, ReferenceTarget *rightParent, int rightSubNum, const MCHAR *leftExpr, const MCHAR *rightExpr=NULL)=0
virtual bool  Connect2Way (ReferenceTarget *leftParent, int leftSubNum, ReferenceTarget *rightParent, int rightSubNum, MCHAR *leftExpr, MCHAR *rightExpr) sealed
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


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 Connect ( ReferenceTarget fromParent,
int  fromSubNum,
ReferenceTarget toParent,
int  toSubNum,
MCHAR *  toExpr 
) [inline, sealed, virtual]
Deprecated:
Deprecated method in terms of implementation as of 3ds Max 2013 - re-implement with const MCHAR* method signature
                                                                              { 
                                                                return Connect(fromParent, fromSubNum, toParent, toSubNum, const_cast<const MCHAR*>(toExpr)); }
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 Connect2Way ( ReferenceTarget leftParent,
int  leftSubNum,
ReferenceTarget rightParent,
int  rightSubNum,
MCHAR *  leftExpr,
MCHAR *  rightExpr 
) [inline, sealed, virtual]
Deprecated:
Deprecated method in terms of implementation as of 3ds Max 2013 - re-implement with const MCHAR* method signature
                                                                                                  { 
                                                                return Connect2Way(leftParent, leftSubNum, rightParent, rightSubNum, const_cast<const MCHAR*>(leftExpr), const_cast<const MCHAR*>(rightExpr)); }
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