#include <simpobj.h>
Public Member Functions |
|
CoreExport | SimpleOSMToWSMObject () |
CoreExport | SimpleOSMToWSMObject (SimpleMod *m) |
int | NumRefs () |
Returns the total number of references this
ReferenceMaker can hold. |
|
CoreExport RefTargetHandle | GetReference (int i) |
Returns the 'i-th' reference. |
|
CoreExport IOResult | Load (ILoad *iload) |
Called for loading data. |
|
int | NumSubs () |
CoreExport Animatable * | SubAnim (int i) |
CoreExport MSTR | SubAnimName (int i) |
CoreExport void | BuildMesh (TimeValue t) |
CoreExport Modifier * | CreateWSMMod (INode *node) |
When the user binds a node to a space warp,
a new modifier must be created and added to the node's WSM derived
object. |
|
CoreExport CreateMouseCallBack * | GetCreateMouseCallBack () |
This method allows the system to retrieve a
callback object used in creating an object in the 3D viewports.
|
|
CoreExport void | BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev) |
CoreExport void | EndEditParams (IObjParam *ip, ULONG flags, Animatable *next) |
CoreExport ParamDimension * | GetParameterDim (int pbIndex) |
CoreExport MSTR | GetParameterName (int pbIndex) |
CoreExport Deformer & | GetDecayDeformer (TimeValue t, Deformer &mdef, Point3 origin, Interval &iv) |
CoreExport SimpleOSMToWSMObject * | SimpleOSMToWSMClone (SimpleOSMToWSMObject *from, RemapDir &remap) |
CoreExport void | InvalidateUI () |
Public Attributes |
|
SimpleMod * | mod |
Static Public Attributes |
|
static IParamMap * | pmapParam |
Protected Member Functions |
|
virtual CoreExport void | SetReference (int i, RefTargetHandle rtarg) |
Stores a
ReferenceTarget as its 'i-th' reference`. |
CoreExport SimpleOSMToWSMObject | ( | ) |
CoreExport SimpleOSMToWSMObject | ( | SimpleMod * | m | ) |
int NumRefs | ( | ) | [inline, virtual] |
Returns the total number of references this ReferenceMaker can hold.
The plugin implements this method to indicate the total number of of references it can make. This includes all references whether they are NULL (inactive) or non-NULL (active) at the time when this method is called. A plugin can hold a variable number of references, thus the return value of this method is not to be cached and reused by client code.
Reimplemented from SimpleWSMObject.
{return 2;}
CoreExport RefTargetHandle GetReference | ( | int | i | ) | [virtual] |
Returns the 'i-th' reference.
The plugin implements this method to return its 'i-th' reference. The plug-in simply keeps track of its references using an integer index for each one. This method is normally called by the system.
i | - The index of the reference to retrieve. Valid values are from 0 to NumRefs()-1. |
Reimplemented from SimpleWSMObject.
virtual CoreExport void SetReference | ( | int | i, |
RefTargetHandle | rtarg | ||
) | [protected, virtual] |
Stores a ReferenceTarget as its 'i-th' reference`.
The plugin implements this method to store the reference handle passed to it as its 'i-th' reference. In its implementation of this method, the plugin should simply assign the reference handle passed in as a parameter to the member variable that holds the 'i-th' reference. Other reference handling methods such as ReferenceMaker::DeleteReference(), or ReferenceMaker::ReplaceReference() should not be called from within this method. The plugin itself or other plugins should not call this method directly. The system will call this method when a new reference is created or an existing one is replaced by calling ReferenceMaker::ReplaceReference().
i | - The index of the reference to store. Valid values are from 0 to NumRefs()-1. |
rtarg | - The reference handle to store. |
Reimplemented from SimpleWSMObject.
Called for loading data.
Called by the system to allow the plug-in to load its data. See the section on Loading and Saving for an overview of the load - save process.
iload | - This interface pointer may be used to call methods to read data from disk. |
Reimplemented from ReferenceMaker.
int NumSubs | ( | ) | [inline, virtual] |
Reimplemented from SimpleWSMObject.
{return 2;}
CoreExport Animatable* SubAnim | ( | int | i | ) | [virtual] |
i | This is the index of the sub-anim to return. |
Reimplemented from SimpleWSMObject.
CoreExport MSTR SubAnimName | ( | int | i | ) | [virtual] |
i | The index of the parameter name to return |
Reimplemented from SimpleWSMObject.
CoreExport void BuildMesh | ( | TimeValue | t | ) | [virtual] |
Implements SimpleWSMObject.
CoreExport CreateMouseCallBack* GetCreateMouseCallBack | ( | ) | [virtual] |
This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
This method returns a pointer to an instance of a class derived from CreateMouseCallBack. This class has a method proc() which is where the programmer defines the user/mouse interaction during the object creation phase.
Implements BaseObject.
CoreExport void BeginEditParams | ( | IObjParam * | ip, |
ULONG | flags, | ||
Animatable * | prev | ||
) | [virtual] |
ip | Interface pointer. The developer can use it to call methods such as AddRollupPage(). Note that this pointer is only valid between BeginEditParams() and EndEditParams(). It should not be used outside this interval. |
flags | Describe which branch of the command panel or dialog the item
is being edited in. The following are possible values: BEGIN_EDIT_CREATE Indicates an item is being edited in the create branch. BEGIN_EDIT_MOTION Indicates a controller is being edited in the motion branch. BEGIN_EDIT_HIERARCHY Indicates a controller is being edited in the Pivot subtask of the hierarchy branch. BEGIN_EDIT_IK Indicates a controller is being edited in the IK subtask of the hierarchy branch. BEGIN_EDIT_LINKINFO Indicates a controller is being edited in the Link Info subtask of the hierarchy branch. |
prev | Pointer to an Animatable object. This parameter may be used in the motion and hierarchy branches of the command panel. This pointer allows a plug-in to look at the ClassID of the previous item that was being edited, and if it is the same as this item, to not replace the entire UI in the command panel, but simply update the values displayed in the UI fields. This prevents the UI from 'flickering' when the current item begins its edit. For example, if you are in the motion branch and are looking at an item's PRS controller values, and then select another item that is displayed with a PRS controller, the UI will not change - only the values displayed in the fields will change. If however you selected a target camera that has a lookat controller (not a PRS controller) the UI will change because a different set of parameters need to be displayed. Note that for items that are edited in the modifier branch this field can be ignored. |
Reimplemented from SimpleWSMObject.
CoreExport void EndEditParams | ( | IObjParam * | ip, |
ULONG | flags, | ||
Animatable * | next | ||
) | [virtual] |
ip | An interface pointer. The developer may use the interface
pointer to call methods such as DeleteRollupPage(). |
flags | The following flag may be set: END_EDIT_REMOVEUI If TRUE, the item's user interface should be removed. |
next | Animatable pointer. Can be used in the motion and hierarchy branches of the command panel. It allows a plug-in to look at the ClassID of the next item that was being edited, and if it is the same as this item, to not replace the entire UI in the command panel. Note that for items that are edited in the modifier branch this field can be ignored. |
Reimplemented from SimpleWSMObject.
CoreExport ParamDimension* GetParameterDim | ( | int | pbIndex | ) | [inline, virtual] |
Reimplemented from SimpleWSMObject.
{return stdWorldDim;}
CoreExport MSTR GetParameterName | ( | int | pbIndex | ) | [virtual] |
Reimplemented from SimpleWSMObject.
CoreExport Deformer& GetDecayDeformer | ( | TimeValue | t, |
Deformer & | mdef, | ||
Point3 | origin, | ||
Interval & | iv | ||
) |
CoreExport SimpleOSMToWSMObject* SimpleOSMToWSMClone | ( | SimpleOSMToWSMObject * | from, |
RemapDir & | remap | ||
) |
CoreExport void InvalidateUI | ( | ) | [virtual] |
Reimplemented from SimpleWSMObject.