3ds Max C++ API Reference
Loading...
Searching...
No Matches
PFSimpleAction Class Referenceabstract

#include <PFSimpleAction.h>

+ Inheritance diagram for PFSimpleAction:

Public Member Functions

PFExport PFSimpleAction ()
 
virtual PFExport ~PFSimpleAction ()
 
virtual PFExport BaseInterfaceGetInterface (Interface_ID id)
 
virtual PFExport void DeleteThis ()
 Deletes an instance of this class.
 
virtual int NumSubs ()
 
virtual PFExport AnimatableSubAnim (int i)
 
virtual PFExport MSTR SubAnimName (int i, bool localized=true) override
 
PFExport BOOL SelectSubAnim (int subNum)
 
virtual PFExport ParamDimensionGetParamDimension (int i)
 
virtual PFExport int SubNumToRefNum (int subNum)
 
virtual BOOL CanCopyAnim ()
 
virtual PFExport int HasSubElements (int type)
 
virtual BOOL CanDeleteSubAnim (int i)
 
virtual BOOL IsAnimated ()
 
virtual void FreeCaches ()
 
virtual int NumParamBlocks ()
 
virtual PFExport IParamBlock2GetParamBlock (int i)
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
virtual PFExport IParamBlock2GetParamBlockByID (short id)
 
virtual int NumRefs ()
 Returns the total number of references this ReferenceMaker can hold.
 
virtual PFExport RefTargetHandle GetReference (int i)
 Returns the 'i-th' reference.
 
virtual PFExport RefResult NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
 Receives and responds to messages.
 
virtual PFExport int RemapRefOnLoad (int iref)
 Used to load old files with references.
 
virtual PFExport IOResult Save (ISave *isave)
 Called for saving data.
 
virtual PFExport IOResult Load (ILoad *iload)
 Called for loading data.
 
virtual PFExport void NotifyTarget (int message, ReferenceMaker *hMaker)
 Sends messages to ReferenceTargets.
 
virtual CreateMouseCallBackGetCreateMouseCallBack ()
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
 
virtual BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System.
 
virtual void InitNodeName (MSTR &s)
 Implemented by the System.
 
virtual ObjectState Eval (TimeValue t)
 This method is called to evaluate the object and return the result as an ObjectState.
 
virtual void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
virtual Class_ID ClassID ()
 Retrieves a constant that uniquely identifies the plugin class.
 
virtual void BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev)=0
 
virtual void EndEditParams (IObjParam *ip, ULONG flags, Animatable *next)=0
 
virtual RefTargetHandle Clone (RemapDir &remap)=0
 This method is used by 3ds Max to clone an object.
 
virtual const MCHARGetObjectName (bool localized=true) const =0
 
virtual PFExport bool Init (IObject *pCont, Object *pSystem, INode *node, Tab< Object * > &actions, Tab< INode * > &actionNodes)
 Returns true if the operation has been proceeded successfully.
 
virtual PFExport bool Release (IObject *pCont)
 See Init().
 
virtual bool SupportRand () const
 An Action may carry some chaos/unpredictibility in its processing.
 
virtual int GetRand ()
 For chaos/unpredictibility action, gets rand value.
 
virtual void SetRand (int seed)
 For chaos/unpredictibility action, sets rand value.
 
virtual PFExport int NewRand ()
 
virtual const ParticleChannelMaskChannelsUsed (const Interval &time) const =0
 See Init().
 
virtual const Interval ActivityInterval () const =0
 Casting the FPValue->ptr parameter to Tab<Interface_ID>* as in PFExport void ChannelsUsed(...); an Action may have a time interval when the Action is active.
 
virtual PFExport IObjectGetCurrentState (IObject *pContainer)
 Returns action state (see IPFActionState.h for details).
 
virtual PFExport void SetCurrentState (IObject *actionState, IObject *pContainer)
 Sets the state of the action to the given state.
 
virtual int NumPViewParamBlocks () const
 
virtual PFExport IParamBlock2GetPViewParamBlock (int i) const
 

 
virtual ClassDescGetClassDesc () const =0
 
PFExport void RefreshUI (WPARAM message, IParamMap2 *map=NULL) const
 
PFExport void UpdatePViewUI (ParamID updateID) const
 
IParamBlock2pblock () const
 
const RandObjLinkerrandLinker () const
 
IParamBlock2 *& _pblock ()
 
RandObjLinker_randLinker ()
 
- Public Member Functions inherited from HelperObject
SClass_ID SuperClassID () override
 Implemented by the System.
 
int IsRenderable () override
 Implemented by the System.
 
virtual void InitNodeName (MSTR &s) override
 Implemented by the System.
 
virtual int UsesWireColor () override
 Implemented by the System.
 
virtual BOOL NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm) override
 Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max.
 
- Public Member Functions inherited from Object
CoreExport Object ()
 
CoreExport ~Object ()
 
virtual BOOL CheckObjectIntegrity ()
 This method is used for debugging only.
 
virtual BOOL HasUVW () override
 Call this method to find out if the object has UVW coordinates.
 
virtual BOOL HasUVW (int mapChannel) override
 Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
 
virtual ObjectFindBaseObject ()
 It is called to return a pointer to the base object (an object that is not a derived object).
 
virtual BOOL IsParamSurface ()
 There are several methods used to access a parametric position on the surface of the object.
 
virtual int NumSurfaces (TimeValue t)
 Returns the number of parametric surfaces within the object.
 
virtual Point3 GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
 This method needs to be implemented if Object::IsParamSurface() returns TRUE.
 
virtual Point3 GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
 This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v.
 
virtual void SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
 This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions.
 
virtual BOOL GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
 This method allows an object to return extended Properties fields.
 
CoreExport SvGraphNodeReference SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
CoreExport bool SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport MSTR SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
 
CoreExport COLORREF SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
 Returns true if the object is selected in its schematic view.
 
CoreExport MultiSelectCallbackSvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport bool SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
 
CoreExport void AddXTCObject (XTCObject *pObj, int priority=0, int branchID=-1)
 This method adds an extension object into the pipeline.
 
CoreExport int NumXTCObjects ()
 Returns the number of extension objects maintained by this Object.
 
CoreExport XTCObjectGetXTCObject (int index)
 Returns a pointer to the specified extension object.
 
CoreExport void RemoveXTCObject (int index)
 Removes the extension object as indicated by the index.
 
CoreExport void SetXTCObjectPriority (int index, int priority)
 Sets the priority for the extension object whose index is passed.
 
CoreExport int GetXTCObjectPriority (int index)
 Returns the integer priority number of the extension object whose index is passed.
 
CoreExport void SetXTCObjectBranchID (int index, int branchID)
 Sets the branch ID of the extension object whose index is passed.
 
CoreExport int GetXTCObjectBranchID (int index)
 Returns the integer branch ID of the extension object whose index is passed.
 
CoreExport void MergeAdditionalChannels (Object *from, int branchID)
 This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it).
 
CoreExport void BranchDeleted (int branchID, bool reorderChannels)
 This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch.
 
CoreExport void CopyAdditionalChannels (Object *from, bool deleteOld=true, bool bShallowCopy=false)
 This method copies all extension objects from the "from" object into the current object.
 
CoreExport void DeleteAllAdditionalChannels ()
 Implemented by the System.
 
virtual BOOL UseSelectionBrackets ()
 This method allows an object to choose whether or not it will display selection brackets in shaded viewports.
 
virtual BOOL IsManipulator ()
 
CoreExport voidGetInterface (ULONG id) override
 
CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual void ReduceDisplayCaches ()
 Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it.
 
virtual bool NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
 This returns whether the Graphics Cache for this object needs to be rebuilt.
 
virtual void BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
 This builds the graphics window cached mesh.
 
virtual void StartStackEval ()
 This are called right before and after a modifier is applied to an object.
 
virtual void EndStackEval ()
 
virtual int DoOwnSelectHilite ()
 If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero.
 
virtual int IntersectRay (TimeValue t, Ray &r, float &at, Point3 &norm)
 This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object.
 
void LockObject ()
 Implemented by the System.
 
void UnlockObject ()
 Implemented by the System.
 
int IsObjectLocked ()
 Implemented by the System.
 
void LockChannels (ChannelMask channels)
 Implemented by the System.
 
void UnlockChannels (ChannelMask channels)
 Implemented by the System.
 
ChannelMask GetChannelLocks ()
 Implemented by the System.
 
void SetChannelLocks (ChannelMask channels)
 Implemented by the System.
 
ChannelMask GetChannelLocks (ChannelMask m)
 Implemented by the System.
 
virtual BOOL CanCacheObject ()
 This method determines if this object can have channels cached.
 
virtual void WSStateInvalidate ()
 This is called by a node when the node's world space state has become invalid.
 
virtual BOOL IsWorldSpaceObject ()
 Returns TRUE if the object as a world space object; otherwise FALSE.
 
CoreExport INodeGetWorldSpaceObjectNode ()
 Implemented by the System.
 
virtual BOOL IsParticleSystem ()
 Implemented by the System.
 
CoreExport void CopyChannelLocks (Object *obj, ChannelMask needChannels)
 Implemented by the System.
 
virtual void TopologyChanged ()
 Implemented by the System.
 
virtual int IsDeformable ()
 Indicates whether this object is deformable.
 
virtual int NumPoints ()
 The points of a deformable object are accessed through a virtual array interface.
 
virtual Point3 GetPoint (int i)
 The points of a deformable object are accessed through a virtual array interface.
 
virtual void SetPoint (int i, const Point3 &p)
 The points of a deformable object are accessed through a virtual array interface.
 
virtual BOOL IsPointSelected (int i)
 Returns TRUE if the 'i-th' point is selected; otherwise FALSE.
 
virtual float PointSelection (int i)
 Returns a floating point weighted point selection if the object supports it.
 
virtual BOOL HasWeights ()
 Returns TRUE if the object has weights for its points that can be set; otherwise FALSE.
 
virtual double GetWeight (int i)
 Returns the weight of the specified point of the object.
 
virtual void SetWeight (int i, const double w)
 Sets the weight of the specified point.
 
virtual BOOL PolygonCount (TimeValue t, int &numFaces, int &numVerts)
 Retreives the number of faces and vertices of the polyginal mesh representation of this object.
 
virtual void PointsWereChanged ()
 Informs the object that its points have been deformed, so it can invalidate its cache.
 
virtual CoreExport void Deform (Deformer *defProc, int useSel=0)
 This is the method used to deform the object with a deformer.
 
virtual CoreExport void GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm=NULL, BOOL useSel=FALSE)
 This method computes the bounding box in the objects local coordinates or the optional space defined by tm.
 
virtual int IsMappable ()
 This method lets you know if the ApplyUVWMap() method is available for this object.
 
virtual int NumMapChannels ()
 Returns the maximum number of channels supported by this type of object.
 
virtual int NumMapsUsed ()
 Returns the number of maps currently used by this object.
 
virtual void ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
 This method may be called to map the object with UVW mapping coordinates.
 
virtual CoreExport int CanConvertToType (Class_ID obtype)
 Indicates whether the object can be converted to the specified type.
 
virtual CoreExport ObjectConvertToType (TimeValue t, Class_ID obtype)
 This method converts this object to the type specified and returns a pointer it.
 
virtual Class_ID PreferredCollapseType ()
 This method allows objects to specify the class that is the best class to convert to when the user collapses the stack.
 
virtual CoreExport void GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
 When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented.
 
virtual ObjectCollapseObject ()
 This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself.
 
virtual DWORD GetSubselState ()
 For objects that have sub selection levels, this method returns the current selection level of the object.
 
virtual void SetSubSelState (DWORD s)
 Implemented by the System.
 
CoreExport void ReadyChannelsForMod (ChannelMask channels)
 Implemented by the System.
 
virtual CoreExport Interval ChannelValidity (TimeValue t, int nchan)
 Retrieve the current validity interval for the nchan channel of the object.
 
virtual CoreExport void SetChannelValidity (int nchan, Interval v)
 Sets the validity interval of the specified channel.
 
virtual CoreExport void InvalidateChannels (ChannelMask channels)
 This method invalidates the intervals for the given channel mask.
 
virtual CoreExport Interval ObjectValidity (TimeValue t)
 This method returns the validity interval of the object as a whole at the specified time.
 
virtual ObjectMakeShallowCopy (ChannelMask channels)
 This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.
 
virtual CoreExport void ShallowCopy (Object *fromOb, ChannelMask channels)
 This method copies the specified channels from the fromOb to this and copies the validity intervals.
 
virtual CoreExport void FreeChannels (ChannelMask channels)
 This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty).
 
virtual CoreExport void NewAndCopyChannels (ChannelMask channels)
 This method replaces the locked channels with newly allocated copies.
 
virtual CoreExport void MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
 This method allows the object to enlarge its viewport rectangle, if it wants to.
 
CoreExport bool IsBaseClassOwnedChannel (int nchan)
 Implemented by the System.
 
CoreExport void UpdateValidity (int nchan, Interval v)
 When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object.
 
Interval GetNoEvalInterval ()
 
void SetNoEvalInterval (Interval iv)
 
virtual CoreExport void ReduceCaches (TimeValue t)
 This method give the object the chance to reduce its caches.
 
virtual int IsConstObject ()
 This is called to determine if this is a construction object or not.
 
virtual int NumPipeBranches (bool selected=true)
 This method returns the number of pipeline branches combined by the object.
 
virtual ObjectGetPipeBranch (int i, bool selected=true)
 Retrieves sub-object branches from an object that supports branching.
 
virtual INodeGetBranchINode (TimeValue t, INode *node, int i, bool selected=true)
 When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object.
 
virtual int NumberOfContainedShapes ()
 Returns the number of shapes contained inside this object.
 
virtual ShapeObjectGetContainedShape (TimeValue t, int index)
 This method returns the ShapeObject specified by the index passed at the time specified.
 
virtual void GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
 Returns the matrix associated with the shape whose index is passed.
 
virtual BitArray ContainedShapeSelectionArray ()
 This is used by the lofter.
 
virtual BOOL IsShapeObject ()
 Returns the number of shapes contained inside this object.
 
- Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long GetObjectDisplayRequirement () const
 
virtual CoreExport bool PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
 
virtual CoreExport bool UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport bool UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArrayGetRenderItems () const
 
virtual CoreExport voidGetInterface (ULONG id) override
 
virtual CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
CoreExport BaseObject ()
 
virtual CoreExport ~BaseObject ()
 
virtual BOOL HasViewDependentBoundingBox ()
 This method return true if GetWorldBoundBox returns different boxes for different viewports.
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
 This method is called to determine if the specified screen point intersects the item.
 
virtual void SetExtendedDisplay (int flags)
 This method is used for storing mode-dependent display attributes.
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
 This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
 
virtual void Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
 Checks the point passed for a snap and updates the SnapInfo structure.
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
 This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
 
virtual void GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
 This is the object space bounding box, the box in the object's local coordinates.
 
 __declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
 
virtual BOOL ChangeTopology ()
 This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE.
 
virtual void ForceNotify (Interval &i)
 Notifies dependents of a change.
 
virtual IParamArrayGetParamBlock ()
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
virtual int GetParamBlockIndex (int id)
 If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block.
 
virtual void Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by moving its selected sub-object components.
 
virtual void Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by rotating its selected sub-object components.
 
virtual void Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by scaling its selected sub-object components.
 
virtual void TransformStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.
 
virtual void TransformHoldingStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect.
 
virtual void TransformHoldingFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted.
 
virtual void TransformFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted.
 
virtual void TransformCancel (TimeValue t)
 This method is called when the transform operation is canceled by a right-click and the undo has been canceled.
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
 This method is used in modifier gizmo hit testing.
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
 When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
 This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).
 
virtual void CloneSelSubComponents (TimeValue t)
 This method is called to make a copy of the selected sub-object components of the item.
 
virtual void AcceptCloneSelSubComponents (TimeValue t)
 This method is called when the user mouses up after shift-cloning a sub-object selection.
 
virtual void SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
 This method is called to change the selection state of the component identified by hitRec.
 
virtual void ClearSelection (int selLevel)
 This method is called to clear the selection for the given sub-object level.
 
virtual void SelectAll (int selLevel)
 This method is called to select every element of the given sub-object level.
 
virtual void InvertSelection (int selLevel)
 This method is called to invert the specified sub-object level.
 
virtual int SubObjectIndex (HitRecord *hitRec)
 Returns the index of the sub-object element identified by the HitRecord hitRec.
 
virtual void ActivateSubobjSel (int level, XFormModes &modes)
 When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in.
 
virtual BOOL SupportsNamedSubSels ()
 An object that supports sub-object selection can choose to support named sub object selection sets.
 
virtual void ActivateSubSelSet (MSTR &setName)
 When the user chooses a name from the drop down list this method is called.
 
virtual void NewSetFromCurSel (MSTR &setName)
 If the user types a new name into the named selection set drop down then this method is called.
 
virtual void RemoveSubSelSet (MSTR &setName)
 If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called.
 
virtual void SetupNamedSelDropDown ()
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual int NumNamedSelSets ()
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual MSTR GetNamedSelSetName (int i)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void SetNamedSelSetName (int i, MSTR &newName)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
 
virtual void GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
 
virtual void NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
 This method is called before a modifier or object is collapsed.
 
virtual void NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
 This method is called after a modifier or object is collapsed.
 
virtual int NumSubObjTypes ()
 Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType().
 
virtual ISubObjTypeGetSubObjType (int i)
 Returns a pointer to the sub-object type for the sub-object whose index is passed.
 
virtual CoreExport int GetSubObjectLevel ()
 This method returns an integer which indicates the current sub-object level of the modifier or base object.
 
virtual void SetGenUVW (BOOL sw)
 This method is called to change the state of its Generate UVW boolean.
 
virtual void SetGenUVW (int mapChannel, BOOL sw)
 This method is called to change the state of its Generate UVW boolean for the specified mapping channel.
 
virtual void ShowEndResultChanged (BOOL showEndResult)
 This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled).
 
- Public Member Functions inherited from ReferenceTarget
CoreExport void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
CoreExport SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
BOOL IsRefTarget () override
 Checks if this is a ReferenceTarget.
 
CoreExport RefResult TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
 Tests for a cyclical reference.
 
CoreExport BOOL HasDependents ()
 Checks if a ReferenceTarget has references.
 
CoreExport BOOL HasRealDependents ()
 Checks if this has Real (Strong) Dependents.
 
void BeginDependencyTest ()
 Starts Dependency Test.
 
BOOL EndDependencyTest ()
 Ends Dependency Test.
 
virtual void RefAdded (RefMakerHandle rm)
 Called after a reference is made to a target.
 
virtual void RefAddedUndoRedo (RefMakerHandle rm)
 Called after a reference is made to a target because of undo or redo.
 
 __declspec (deprecated) virtual void RefDeleted() final
 
virtual void RefDeleted (ReferenceMaker *oldOwner)
 Called after a reference to this is deleted.
 
 __declspec (deprecated) virtual void RefDeletedUndoRedo() final
 
virtual void RefDeletedUndoRedo (RefMakerHandle oldOwner)
 Called after a reference to this is deleted because of undo or redo.
 
CoreExport RefResult DeleteAllRefsToMe () override
 Deletes all references to this ReferenceTarget.
 
CoreExport RefResult TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
 Transfers all the references from oldTarget to this.
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network.
 
virtual CoreExport void BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
 This method copies base class data from an object to its clone.
 
CoreExport RefResult NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
 Notify all dependent RefMakers concerned with the message.
 
void FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
 This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
 
virtual void NotifyForeground (TimeValue t)
 This method is called to flag dependents into the FG.
 
CoreExport voidGetInterface (ULONG id) override
 Inherited from Animatable.
 
CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 Inherited from Animatable.
 
CoreExport ReferenceTarget ()
 Constructor.
 
virtual CoreExport RefResult AutoDelete ()
 Deletes the object when it has no more real dependents.
 
CoreExport RefResult MaybeAutoDelete ()
 Deletes the object when it has no more real dependents.
 
- Public Member Functions inherited from ReferenceMaker
void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
CoreExport SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
CoreExport RefResult ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
 Used when cloning reference makers.
 
CoreExport RefResult DeleteAllRefsFromMe ()
 Deletes all references from this ReferenceMaker.
 
CoreExport RefResult DeleteAllRefs ()
 Deletes all references both to and from this item.
 
CoreExport RefResult DeleteReference (int i)
 Deletes the specified reference.
 
virtual BOOL CanTransferReference (int i)
 Tells whether this reference can be transfered.
 
CoreExport ReferenceSaveManagerGetReferenceSaveManager ()
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport IOResult Save (ISave *isave, ChannelMask)
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport IOResult Load (ILoad *iload, ChannelMask)
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport void RescaleWorldUnits (float f)
 Rescale size of all world units in reference hierarchy.
 
CoreExport void EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
 Enumerate auxiliary files (e.g. bitmaps)
 
virtual CoreExport void SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
 The default save enumeration.
 
virtual CoreExport bool SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
 Used to specify reference slot remapping during scene file save.
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network.
 
CoreExport bool EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
 This method provides a general purpose reference enumerator.
 
CoreExport int FindRef (RefTargetHandle rtarg)
 Get the index of the ReferenceTarget.
 
BOOL IsRefMaker () override
 Tells whether it is a ReferenceMaker.
 
virtual BOOL IsRealDependency (ReferenceTarget *rtarg)
 Returns whether this is a "real" (strong) dependency or not.
 
virtual BOOL ShouldPersistWeakRef (RefTargetHandle rtarg)
 Specifies whether a weak reference is to be persisted on a partial load or save.
 
CoreExport ReferenceMaker ()
 Constructor.
 
CoreExport void DeleteMe ()
 Deletes an instance of this class.
 
- Public Member Functions inherited from Animatable
virtual void FreeCaches ()
 
virtual int NumChildren ()
 
virtual AnimatableChildAnim (int i)
 
virtual CoreExport MSTR NodeName ()
 
virtual void EditTrack ()
 
virtual CoreExport BOOL SubAnimSetKeyBufferPresent (int subNum)
 returns true if the sub-anim has a "Set Key" buffer present
 
virtual BOOL SetKeyBufferPresent ()
 returns true if there is a "Set Key" buffer present
 
virtual CoreExport void SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
 Commit any "Set Key" buffers on the given sub-anim.
 
virtual void CommitSetKeyBuffer (TimeValue t)
 Commit any "Set Key" buffers.
 
virtual CoreExport void SubAnimRevertSetKeyBuffer (int subNum)
 Revert any "Set Key" buffers on the given sub-anim.
 
virtual void RevertSetKeyBuffer ()
 Revert any "Set Key" buffers.
 
virtual LRESULT CALLBACK TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 This function is obsolete.
 
virtual BOOL IsRefMaker ()
 Tells whether it is a ReferenceMaker.
 
virtual bool IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
 Returns true if the passed description is being used.
 
virtual bool GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
 This method is called to access the object specified name to use for the Maxscript macrorecorder.
 
CoreExport Animatable ()
 Constructor.
 
MSTR ClassName (bool localized=true) const
 Returns the name of the plugin class.
 
virtual CoreExport void ReleaseInterface (ULONG id, void *i)
 
virtual CoreExport int SetProperty (ULONG id, void *data)
 
virtual CoreExport voidGetProperty (ULONG id)
 
CoreExport void AppendProperty (AnimProperty *prop)
 A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs.
 
CoreExport AnimPropertyFindProperty (DWORD id)
 Find any property.
 
CoreExport void AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
 Adds application/plugin specific (custom) data to an Animatable.
 
CoreExport AppDataChunkGetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Retrieves the application/plugin specific (custom) data stored with an Animatable.
 
CoreExport BOOL RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Deletes the application/plugin specific (custom) data stored with an Animatable.
 
CoreExport void ClearAllAppData ()
 Deletes all application/plugin specific (custom) data stored with an Animatable.
 
 __declspec (deprecated) virtual MSTR SubAnimName(int i) MAX_SEALED
 
virtual void DeleteSubAnim (int i)
 
virtual DWORD GetSubAnimCurveColor (int subNum)
 
CoreExport int HasSubElements (int type=0)
 
virtual int GetSubFCurveExtents (int subNum, ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 The values max and min should be initialized before calling this function.
 
virtual BOOL BypassTreeView ()
 
virtual BOOL BypassTrackBar ()
 
virtual BOOL BypassPropertyLevel ()
 
virtual BOOL InvisibleProperty ()
 
virtual int NumKeys ()
 
virtual TimeValue GetKeyTime (int index)
 
virtual int GetKeyIndex (TimeValue t)
 
virtual BOOL GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
 
virtual void CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
 
virtual void DeleteKeyAtTime (TimeValue t)
 
virtual BOOL IsKeyAtTime (TimeValue t, DWORD flags)
 
virtual int GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
 
virtual int GetKeySelState (BitArray &sel, Interval range, DWORD flags)
 
CoreExport void OpenTreeEntry (int type, DWORD tv)
 
CoreExport void CloseTreeEntry (int type, DWORD tv)
 
CoreExport int IsTreeEntryOpen (int type, DWORD tv)
 
CoreExport BOOL GetSelInTrackView (DWORD tv)
 
CoreExport void SetSelInTrackView (DWORD tv, BOOL sel)
 
CoreExport BOOL InTrackViewSelSet (int which)
 
CoreExport void SetTrackViewSelSet (int which, BOOL inOut)
 
virtual BOOL AssignController (Animatable *control, int subAnim)
 
virtual BOOL CanAssignController (int subAnim)
 Return true if we can reassign the subanim specified.
 
virtual BOOL CanMakeUnique ()
 
CoreExport int EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
 
virtual int RenderBegin (TimeValue t, ULONG flags=0)
 
virtual int RenderEnd (TimeValue t)
 
virtual CoreExport Interval GetTimeRange (DWORD flags)
 
virtual void EditTimeRange (Interval range, DWORD flags)
 
virtual void DeleteTime (Interval iv, DWORD flags)
 
virtual void ReverseTime (Interval iv, DWORD flags)
 
virtual void ScaleTime (Interval iv, float s)
 
virtual void InsertTime (TimeValue ins, TimeValue amount)
 
virtual BOOL SupportTimeOperations ()
 
virtual CoreExport void MapKeys (TimeMap *map, DWORD flags)
 
virtual void DeleteKeys (DWORD flags)
 
virtual void DeleteKeyByIndex (int index)
 
virtual void SelectKeys (TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubCurve (int subNum, BOOL sel)
 
virtual void SelectKeyByIndex (int i, BOOL sel)
 
virtual BOOL IsKeySelected (int i)
 
virtual void FlagKey (TrackHitRecord hit)
 
virtual int GetFlagKeyIndex ()
 
virtual int NumSelKeys ()
 
virtual void CloneSelectedKeys (BOOL offset=FALSE)
 
virtual void AddNewKey (TimeValue t, DWORD flags)
 
virtual void MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
 
virtual void ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
 
virtual void SelectCurve (BOOL sel)
 
virtual BOOL IsCurveSelected ()
 Returns TRUE if the function curve is selected; otherwise returns FALSE.
 
virtual BOOL IsSubCurveSelected (int subNum)
 Returns the selected state of the sub-curve whose index is passed.
 
virtual int GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
 
virtual void SetSelKeyCoords (TimeValue t, float val, DWORD flags)
 
virtual int SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
 
virtual BOOL CanCopyTrack (Interval iv, DWORD flags)
 
virtual BOOL CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopyTrack (Interval iv, DWORD flags)
 
virtual void PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual BOOL CanCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual BOOL CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual void PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual int GetTrackVSpace (int lineHeight)
 
virtual int HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
 
virtual int PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual void EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
 
virtual int TrackParamsType ()
 
virtual int GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 This method is called to calculate the largest and smallest values of the anim.
 
CoreExport void AddNoteTrack (NoteTrack *note)
 
CoreExport void DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
 
CoreExport BOOL HasNoteTracks ()
 
CoreExport int NumNoteTracks ()
 
CoreExport NoteTrackGetNoteTrack (int i)
 
virtual void FreeAllBitmaps ()
 
virtual void GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
 
virtual BOOL IsSubClassOf (Class_ID classID)
 returns true if the animatable has sub-classed off the given class
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
CoreExport bool SvSaveData (ISave *isave, USHORT id)
 
CoreExport bool SvLoadData (ILoad *iLoad)
 
CoreExport DWORD SvGetRefIndex ()
 
CoreExport void SvSetRefIndex (DWORD i)
 
CoreExport bool SvDeleteRefIndex ()
 
CoreExport SvGraphNodeReference SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
 
virtual CoreExport bool SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
 
virtual CoreExport bool SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
 
virtual CoreExport bool SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
 Called when the user deletes this object in the schematic view...
 
virtual CoreExport bool SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport COLORREF SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
 
virtual CoreExport bool SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
 
virtual CoreExport bool SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport MSTR SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"...
 
virtual CoreExport bool SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns true if this object can respond to the SvDetachRel(...) method...
 
virtual CoreExport bool SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Detach this relationship.
 
virtual CoreExport bool SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Called when this relationship is double-clicked in the schematic view...
 
CoreExport ICustAttribContainerGetCustAttribContainer ()
 This method returns a pointer to the custom attributes container interface class.
 
CoreExport void AllocCustAttribContainer ()
 This method allocates space for a custom attributes container.
 
CoreExport void DeleteCustAttribContainer ()
 This method deletes space used by a custom attributes container.
 
void SetAFlag (DWORD mask)
 
void ClearAFlag (DWORD mask)
 Clears one or more bits in the Animatable flags.
 
bool TestAFlag (DWORD mask) const
 Tests one or more bits in the Animatable flags.
 
void SetAFlagEx (DWORD mask)
 Sets one or more bits in the Animatable extended flags.
 
void ClearAFlagEx (DWORD mask)
 Clears one or more bits in the Animatable extended flags.
 
bool TestAFlagEx (DWORD mask) const
 Tests one or more bits in the Animatable extended flags.
 
CoreExport bool TestFlagBit (int index)
 Tests the specified flag bit.
 
CoreExport void SetFlagBit (int index, bool newValue=true)
 Sets the specified flag bit.
 
CoreExport void ClearFlagBit (int index)
 Clears the specified flag bit.
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 
- Public Member Functions inherited from IPFAction
 FN_5 (kInit, TYPE_bool, Init, TYPE_IOBJECT, TYPE_OBJECT, TYPE_INODE, TYPE_OBJECT_TAB_BR, TYPE_INODE_TAB_BR)
 
 FN_1 (kRelease, TYPE_bool, Release, TYPE_IOBJECT)
 
 VFN_2 (kChannelsUsed, ChannelsUsed, TYPE_INTERVAL_BR, TYPE_FPVALUE)
 
 FN_0 (kActivityInterval, TYPE_INTERVAL_BV, ActivityInterval)
 
 FN_0 (kIsFertile, TYPE_bool, IsFertile)
 
 FN_0 (kIsNonExecutable, TYPE_bool, IsNonExecutable)
 
 FN_0 (kSupportRand, TYPE_bool, SupportRand)
 
 FN_0 (kGetRand, TYPE_INT, GetRand)
 
 VFN_1 (kSetRand, SetRand, TYPE_INT)
 
 FN_0 (kNewRand, TYPE_INT, NewRand)
 
 FN_0 (kIsMaterialHolder, TYPE_bool, IsMaterialHolder)
 
 FN_0 (kGetMaterial, TYPE_MTL, GetMaterial)
 
 FN_1 (kSetMaterial, TYPE_bool, SetMaterial, TYPE_MTL)
 
 FN_0 (kSupportScriptWiring, TYPE_bool, SupportScriptWiring)
 
 FN_0 (kGetUseScriptWiring, TYPE_bool, GetUseScriptWiring)
 
 VFN_1 (kSetUseScriptWiring, SetUseScriptWiring, TYPE_bool)
 
virtual bool Init (IObject *pCont, Object *pSystem, INode *node, Tab< Object * > &actions, Tab< INode * > &actionNodes)=0
 Returns true if the operation has been proceeded successfully.
 
virtual bool Release (IObject *pCont)=0
 See Init().
 
virtual const ParticleChannelMaskChannelsUsed (const Interval &time) const =0
 See Init().
 
PFExport void ChannelsUsed (const Interval &time, FPValue *channels) const
 "Function publishing" alternative for ChannelsUsed method.
 
virtual const Interval ActivityInterval () const =0
 Casting the FPValue->ptr parameter to Tab<Interface_ID>* as in PFExport void ChannelsUsed(...); an Action may have a time interval when the Action is active.
 
virtual bool IsFertile () const
 Birth Action is a special type of actions since it can create particles from scratch.
 
virtual bool IsNonExecutable () const
 There is a special case of non-executable actions.
 
virtual bool Has3dIcon () const
 An action may have 3d icon representation in viewport.
 
virtual int IsColorCoordinated () const
 If an operator/test has a 3D icon the icon can be automatically color matched to the color of the display operator in the same event.
 
virtual bool SupportRand () const =0
 An Action may carry some chaos/unpredictibility in its processing.
 
virtual int GetRand ()=0
 For chaos/unpredictibility action, gets rand value.
 
virtual void SetRand (int seed)=0
 For chaos/unpredictibility action, sets rand value.
 
PFExport int NewRand ()
 For chaos/unpredictibility action, sets and returns new rand value.
 
virtual bool IsMaterialHolder () const
 If the Action may potentically change particle material, then return true.
 
virtual MtlGetMaterial ()
 Returns a material for particles.
 
virtual bool SetMaterial (Mtl *mtl)
 Return true if material was set successfully.
 
virtual bool SupportScriptWiring () const
 An Action may have parameters controlled by script channels.
 
virtual bool GetUseScriptWiring () const
 Supports script wiring.
 
virtual void SetUseScriptWiring (bool useScriptWiring)
 Supports script wiring.
 
virtual bool IsEmitterTMDependent () const
 An Action may or may not be dependent on the particle system emitter.
 
virtual bool IsEmitterPropDependent () const
 Checks the props category for dependency.
 
virtual IObjectGetCurrentState (IObject *pContainer)
 Returns action state (see IPFActionState.h for details).
 
virtual void SetCurrentState (IObject *actionState, IObject *pContainer)
 Sets the state of the action to the given state.
 
FPInterfaceDescGetDesc ()
 
- Public Member Functions inherited from FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDesc ()=0
 
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)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor.
 
UtilExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual UtilExport Interface_ID GetID ()
 
virtual LifetimeType LifetimeControl ()
 
virtual bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 
- Public Member Functions inherited from IPViewItem
 FN_0 (kNumPViewParamBlocks, TYPE_INT, NumPViewParamBlocks)
 
 FN_1 (kGetPViewParamBlock, TYPE_REFTARG, GetPViewParamBlock, TYPE_INDEX)
 
 FN_1 (kHasComments, TYPE_bool, HasComments, TYPE_INODE)
 
 FN_1 (kGetComments, TYPE_STRING, GetComments, TYPE_INODE)
 
 VFN_2 (kSetComments, SetComments, TYPE_INODE, TYPE_STRING)
 
 FN_2 (kGetWireExtension, TYPE_INT, GetWireExtension, TYPE_INODE, TYPE_INT)
 
 VFN_3 (kSetWireExtension, SetWireExtension, TYPE_INODE, TYPE_INT, TYPE_INT)
 
 IPViewItem ()
 
virtual int NumPViewParamBlocks () const =0
 
virtual IParamBlock2GetPViewParamBlock (int i) const =0
 

 
PFExport int NumPViewParamMaps () const
 
PFExport IParamMap2GetPViewParamMap (int i) const
 
PFExport void AddPViewParamMap (IParamMap2 *map)
 
PFExport void RemovePViewParamMap (IParamMap2 *map)
 
virtual bool HasCustomPViewIcons ()
 Implement if you want your operator/test to be shown with a custom icon in ParticleView.
 
virtual bool HasTransparentPViewIcons () const
 Defines whether the custom icons in Particle View have alpha channels.
 
virtual HBITMAP GetActivePViewIcon ()
 Implement if you want your operator/test to be shown with a custom icon in ParticleView.
 
virtual HBITMAP GetInactivePViewIcon ()
 Implement if you want your operator/test to be shown with a custom icon in ParticleView.
 
virtual HBITMAP GetTruePViewIcon ()
 Implement if you want your operator/test to be shown with a custom icon in ParticleView.
 
virtual HBITMAP GetFalsePViewIcon ()
 Implement if you want your operator/test to be shown with a custom icon in ParticleView.
 
virtual bool ShowColorSwatch () const
 An operator may have a color swatch UI (color circle on the right side) if it can be used to display particles in viewport.
 
PFExport int GetNumInstances () const
 Used to track instanced actions.
 
PFExport void SetNumInstances (int num)
 Used to track instanced actions.
 
PFExport void IncNumInstances ()
 Used to track instanced actions.
 
PFExport bool HasComments (INode *itemNode) const
 A PView item can have comments.
 
PFExport const MCHARGetComments (INode *itemNode) const
 See HasComments().
 
PFExport void SetComments (INode *itemNode, const MCHAR *comments)
 See HasComments().
 
PFExport void EditComments (INode *itemNode, HWND parentWnd, long x, long y)
 See HasComments().
 
PFExport LRESULT CALLBACK commentsProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 For internal use.
 
virtual bool HasDynamicName (MSTR &nameSuffix)
 For dynamic names support; if the action has a dynamic name then it supplies the name suffix.
 
FPInterfaceDescGetDesc ()
 
- Public Member Functions inherited from SlateModelWrapper
 SlateModelWrapper ()
 
 SlateModelWrapper (const SlateModelWrapper &slateModelWrapper)
 
virtual ~SlateModelWrapper ()
 
Slate::IModel * GetModel ()
 Returns a pointer to the original wrapped slate model.
 
void SetDirection (Direction direction)
 Sets the connection direction of the wrapped slate model.
 
void NotifyListenersDisplayColorChanged ()
 Helpers for the public maxsdk sample class PFOperatorDisplay.
 
void DefineColorSwatchUI ()
 Helpers for the public maxsdk sample class PFOperatorDisplay.
 
void RefreshColorSwatchVisibility ()
 Helpers for the public maxsdk sample class PFOperatorDisplay.
 
void RefMakerNotifyTarget (int message, ReferenceMaker *hMaker)
 Need to be called by NotifyTarget( int message, ReferenceMaker* hMaker ) in the object that derives from SlateModelWrapper.
 

Protected Member Functions

virtual PFExport void SetReference (int i, RefTargetHandle rtarg)
 Stores a ReferenceTarget as its 'i-th' reference`.
 
- Protected Member Functions inherited from ReferenceTarget
CoreExport int DoEnumDependentsImpl (DependentEnumProc *dep) override
 Method to perform an enumeration on a ReferenceTarget.
 
virtual CoreExport ~ReferenceTarget ()=0
 Destructor.
 
- Protected Member Functions inherited from ReferenceMaker
virtual CoreExport ~ReferenceMaker ()=0
 Destructor.
 
void BlockEval ()
 Validates a given reference link between this reference maker and its reference target.
 
void UnblockEval ()
 Validates a given reference link between this reference maker and its reference target.
 
int Evaluating ()
 Validates a given reference link between this reference maker and its reference target.
 
CoreExport RefResult StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
 Validates a given reference link between this reference maker and its reference target.
 
- Protected Member Functions inherited from Animatable
virtual CoreExport ~Animatable ()=0
 Destructor.
 
- Protected Member Functions inherited from Noncopyable
 Noncopyable ()
 
 ~Noncopyable ()
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 

Protected Attributes

IParamBlock2m_pblock
 
RandObjLinker m_randLinker
 
- Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray mRenderItemHandles
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 
- Protected Attributes inherited from IPViewItem
Tab< IParamMap2 * > m_paramMaps
 
int m_numInstances
 
Tab< INode * > m_nodes
 
Tab< HWND > m_hWnds
 

Additional Inherited Members

- Public Types inherited from IPFAction
enum  {
  kInit , kRelease , kChannelsUsed , kActivityInterval ,
  kIsFertile , kIsNonExecutable , kSupportRand , kGetRand ,
  kSetRand , kNewRand , kIsMaterialHolder , kGetMaterial ,
  kSetMaterial , kSupportScriptWiring , kGetUseScriptWiring , kSetUseScriptWiring
}
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 
- Public Types inherited from IPViewItem
enum  {
  kNumPViewParamBlocks , kGetPViewParamBlock , kHasComments , kGetComments ,
  kSetComments , kGetWireExtension , kSetWireExtension
}
 
- Public Types inherited from SlateModelWrapper
enum  Direction { Direction_None = 0x0 , Direction_In = 0x1 , Direction_Out = 0x2 , Direction_Both = 0x3 }
 
- Static Public Member Functions inherited from Animatable
static CoreExport BOOL IsDeleted (Animatable *anim)
 Debug method to determine whether an object has been deleted.
 
static CoreExport AnimHandle GetHandleByAnim (Animatable *anim)
 Get the unique handle for an Animatable object.
 
static CoreExport AnimatableGetAnimByHandle (AnimHandle handle)
 Get an Animatable object from its unique handle.
 
static CoreExport AnimHandle GetNextHandle ()
 Get the unique handle for the next Animatable object to be created.
 
static CoreExport void EnumerateAllAnimatables (EnumAnimList &enumProcObject)
 Enumerator to enumerate across all animatables.
 
static CoreExport bool RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport void ClearAFlagInAllAnimatables (DWORD mask)
 Clears one or more bits in the Animatable flags in all Animatables.
 
static CoreExport void ClearAFlagExInAllAnimatables (DWORD mask)
 Clears one or more bits in the Animatable extended flags in all Animatables.
 
static CoreExport int RequestFlagBit ()
 Requests an unique flag bit index.
 
static CoreExport void ReleaseFlagBit (int index)
 Releases the flag bit index.
 
static CoreExport void ClearFlagBitInAllAnimatables (int index)
 Clears the specified flag bit in all Animatables.
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
static UtilExport voidoperator 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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
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.
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator.
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
 
- Static Public Member Functions inherited from IPFAction
static PFExport int NewRand (IParamBlock2 *pblock, ParamID randomSeedParamID)
 Alternative for PFExport int NewRand(); but not in FnPub interface.
 
- Static Public Member Functions inherited from IPViewItem
static PFExport int GetWireExtension (INode *node, int &wireHeight)
 To read/modify the length/height of the wire nub extended from an emitter, or an action list, or a test.
 
static PFExport void SetWireExtension (INode *node, int wireLen, int wireHight)
 Sets wire length.
 
- Static Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- Static Public Attributes inherited from IPViewItem
static const DWORD PViewItemCommentsChunk = 0x354b7085
 

Constructor & Destructor Documentation

◆ PFSimpleAction()

◆ ~PFSimpleAction()

virtual PFExport ~PFSimpleAction ( )
virtual

Member Function Documentation

◆ GetInterface()

virtual PFExport BaseInterface * GetInterface ( Interface_ID  id)
virtual
Remarks
Returns a pointer to the interface whose ID is specified.
Parameters:
Interface_ID id

The ID of the interface to return.
Default Implementation:
{ return NULL; }

Reimplemented from FPMixinInterface.

Reimplemented in PFSimpleOperator, and PFSimpleTest.

◆ DeleteThis()

virtual PFExport void DeleteThis ( )
virtual

Deletes an instance of this class.

3ds Max calls this method when it needs to delete a plugin object (an instance of a class derived from Animatable). Similarly, plugins that need to delete instances of an Animatable or a class directly derived from it via an Animatable pointer, should call this method instead of calling directly operator delete. Following these rules will ensure that the same memory manager is used to allocate and deallocate the object. The default implementation of this method deletes the object. Plugin instances that never need to be deleted from the heap can overwrite this method to do nothing.

Note
See the method ClassDesc::Create() for details on how Max allocates plugin objects.
See ReferenceMaker::DeleteMe() and ReferenceTarget::MaybeAutoDelete() for information on how plugin instances are deleted by the system.
Remarks
See Memory Management.

See also
Required DLL Functions, Class ClassDesc.

Reimplemented from Animatable.

◆ NumSubs()

virtual int NumSubs ( )
inlinevirtual
Remarks
The system uses a virtual array mechanism to access the sub-anims of a plug-in. This method returns the total number of sub-anims maintained by the plug-in. If a plug-in is using a parameter block to manage its parameters it should just return 1 for all the parameters directed by the parameter block.
Returns
The number of sub-anims used by the plug-in.
Default Implementation:
{ return 0; }

Reimplemented from Animatable.

51{ return 1; } // the paramBlock

◆ SubAnim()

virtual PFExport Animatable * SubAnim ( int  i)
virtual
Remarks
This method returns a pointer to the 'i-th' sub-anim. If a plug-in is using a parameter block to manage all its parameters it should just return a pointer to the parameter block itself from this method. This method may return NULL so developers need to check the return value before calling other sub anim methods (such as SubAnimName()).
Parameters
iThis is the index of the sub-anim to return.
Default Implementation:
{ return NULL };

Reimplemented from Animatable.

◆ SubAnimName()

virtual PFExport MSTR SubAnimName ( int  i,
bool  localized = true 
)
overridevirtual
Remarks
This method returns the name of the 'i-th' sub-anim to appear in track view. The system has no idea what name to assign to the sub-anim (it only knows it by the virtual array index), so this method is called to retrieve the name to display. Developer need to make sure the 'i-th' SubAnim() is non-NULL or this method will fail.
Parameters
iThe index of the parameter name to return
localizedIf true, then the sub-anim name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the sub-anim name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the sub-anim name in English.
Returns
The name of the 'i-th' parameter.

Reimplemented from Animatable.

◆ SelectSubAnim()

PFExport BOOL SelectSubAnim ( int  subNum)
virtual
Remarks
This method is available in release 2.0 and later only.

When a user is in Track View in Edit Keys mode and clicks on the green triangle of a controller then this method will be called on the client with the appropriate sub number that corresponds to it. For instance, the Editable Mesh object implements this to allow the user to select vertices that are animated from the Track View.
Parameters
subNumThe index of the sub-anim that was clicked on.
Returns
TRUE if implemented; otherwise FALSE. (Track View will call RedrawViewports() if something returns TRUE from this method).
Default Implementation:
{return FALSE;}

Reimplemented from Animatable.

◆ GetParamDimension()

virtual PFExport ParamDimension * GetParamDimension ( int  i)
virtual
Remarks
Returns the type of dimension of the 'i-th' sub-anim. A dimension describes the type and order of magnitude of a sub-anim.
Parameters
iSpecifies the sub-anim (parameter) to return the dimension of.
Returns
The dimension of the 'i-th' sub-anim (parameter).
Default Implementation:
{return defaultDim;}

Reimplemented from Animatable.

◆ SubNumToRefNum()

virtual PFExport int SubNumToRefNum ( int  subNum)
virtual
Remarks
This method is used for copying and pasting in the track view. It converts an anim index to a reference index or returns -1 if there is no correspondence. If a client does not wish an anim to be copied or pasted then it can return -1 even if there is a corresponding reference num.
Parameters
subNumThe anim index to return the corresponding reference index of.
Default Implementation:
{ return -1}
Returns
The reference index corresponding to the anim index passed. Return -1 if there is no correspondence.

Reimplemented from Animatable.

◆ CanCopyAnim()

virtual BOOL CanCopyAnim ( )
inlinevirtual
Remarks
In addition to SubNumToRefNum(), if an anim doesn't want to be copied (via Track View or the Edit Modifier Stack 'Copy' button) it can return FALSE from this method, otherwise it can use the default implementation to return TRUE.
Default Implementation:
{return TRUE;}

Reimplemented from Animatable.

57{ return FALSE; }

◆ HasSubElements()

virtual PFExport int HasSubElements ( int  type)
virtual

◆ CanDeleteSubAnim()

virtual BOOL CanDeleteSubAnim ( int  i)
inlinevirtual
Remarks
Returns TRUE if the specified sub-anim controller can be deleted; otherwise FALSE.

A new "Delete Controller" button has been added to the Track View toolbar that is enabled when one or more delete-able tracks are selected. This method allows a plug-in to indicate to the Track View that one or more of its sub-controllers are delete-able. This provides a way to allow the user to delete node sub-controllers such as the visibility track, "Image Motion Blur Multiplier", "Object Motion Blur On/Off", etc. If the user selects one of the above-mentioned tracks in the Track View the "Delete Controller" button will become available.
Parameters
iThe zero based index of the sub-anim.
Default Implementation:
{return FALSE;}

Reimplemented from Animatable.

61{ return FALSE; }

◆ IsAnimated()

virtual BOOL IsAnimated ( )
inlinevirtual
Remarks
Returns TRUE if this animatable actually has animation; otherwise FALSE. This method is recursive, so for example, if you call node->IsAnimated() it will return TRUE if any aspect of the node is animated; otherwise it will return FALSE.
Default Implementation:
The default implementation returns TRUE if a child anim has animation.

Reimplemented from Animatable.

62{ return _pblock()->IsAnimated(); }
virtual CoreExport BOOL IsAnimated()
IParamBlock2 *& _pblock()
Definition: PFSimpleAction.h:162

◆ FreeCaches()

virtual void FreeCaches ( )
inlinevirtual
Remarks
This is called to delete any item that can be rebuilt. For example, the procedural sphere object has a mesh that it caches. It could call Mesh::FreeAll() on the mesh from this method. This will free the vertex/face/uv arrays. If the sphere is ever evaluated again it can just rebuild the mesh. If an object (like a sphere) has modifiers applied to it, and those modifiers are not animated, then the result of the pipeline is cached in the node. So there is no reason for the sphere to also have a cache of its representation. Therefore when this method is called, the sphere can free the data of the mesh.
Default Implementation:
{}

Reimplemented from Animatable.

63{ ; }

◆ NumParamBlocks()

virtual int NumParamBlocks ( )
inlinevirtual
Remarks
This method is available in release 3.0 and later only.

This method returns the number of ParamBlock2s in this instance.
Default Implementation:
{ return 0; }

Reimplemented from Animatable.

64{ return 1; } // the paramBlock

◆ GetParamBlock()

virtual PFExport IParamBlock2 * GetParamBlock ( int  i)
virtual

An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.

The system itself doesn't actually call this method. This method is optional.

Returns
A pointer to the item's parameter block. See Class IParamArray.

Reimplemented from BaseObject.

◆ GetParamBlockByID()

virtual PFExport IParamBlock2 * GetParamBlockByID ( short  id)
virtual
Remarks
This method returns a pointer to the ParamBlock2 as specified by the ID passed (or NULL if not available).
Parameters
idThe BlockID of the ParamBlock2 instance.
Default Implementation:
{ return NULL; }

Reimplemented from Animatable.

◆ NumRefs()

virtual int NumRefs ( )
inlinevirtual

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.

Returns
The total number of references this plugin can hold. The default implementation is return 0.

Reimplemented from ReferenceMaker.

69{ return 1; }

◆ GetReference()

virtual PFExport 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.

Parameters
i- The index of the reference to retrieve. Valid values are from 0 to NumRefs()-1.
Returns
The reference handle of the 'i-th' reference. Note that different calls to this method with the same 'i' value can result in different reference handles being retrieved, as the plugin changes the scene objects it references as its 'i-th' reference.

Reimplemented from ReferenceMaker.

◆ SetReference()

virtual PFExport void SetReference ( int  i,
RefTargetHandle  rtarg 
)
protectedvirtual

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().

Parameters
i- The index of the reference to store. Valid values are from 0 to NumRefs()-1.
rtarg- The reference handle to store.

Reimplemented from ReferenceMaker.

◆ NotifyRefChanged()

virtual PFExport RefResult NotifyRefChanged ( const Interval changeInt,
RefTargetHandle  hTarget,
PartID partID,
RefMessage  message,
BOOL  propagate 
)
virtual

Receives and responds to messages.

A plugin which makes references must implement a method to receive and respond to messages broadcast by its dependents. This is done by implementing NotifyRefChanged(). The plugin developer usually implements this method as a switch statement where each case is one of the messages the plugin needs to respond to. The Method StdNotifyRefChanged calls this, which can change the partID to new value. If it doesn't depend on the particular message& partID, it should return REF_DONTCARE.

  • For developer that need to update a dialog box with data about an object you reference note the following related to this method: This method may be called many times. For instance, say you have a dialog box that displays data about an object you reference. This method will get called many time during the drag operations on that object. If you updated the display every time you'd wind up with a lot of 'flicker' in the dialog box. Rather than updating the dialog box each time, you should just invalidate the window in response to the NotifyRefChanged() call. Then, as the user drags the mouse your window will still receive paint messages. If the scene is complex the user may have to pause (but not let up on the mouse) to allow the paint message to go through since they have a low priority. This is the way many windows in 3ds Max work.
Parameters
changeInt- This is the interval of time over which the message is active. Currently, all plug-ins will receive FOREVER for this interval, with the exception of REFMSG_FLAGDEPENDENTS notifications. In that case, changeInt.Start() is the timepoint to perform the dependency test.
hTarget- This is the handle of the reference target the message was sent by. The reference maker uses this handle to know specifically which reference target sent the message.
partID- This contains information specific to the message passed in. Some messages don't use the partID at all. See the section List of Reference Messages for more information about the meaning of the partID for some common messages.
message- The message parameters passed into this method is the specific message which needs to be handled.
propagate- If called through ReferenceMaker::NotifyDependents(), the value of 'propagate' passed to it. Used if calling NotifyDependents() from within NotifyRefChanged().
Returns
The return value from this method is of type RefResult. This is usually REF_SUCCEED indicating the message was processed. Sometimes, the return value may be REF_STOP. This return value is used to stop the message from being propagated to the dependents of the item.

Implements ReferenceMaker.

◆ RemapRefOnLoad()

virtual PFExport int RemapRefOnLoad ( int  iref)
virtual

Used to load old files with references.

Implement this if you have added or deleted references and are loading an old file that needs to have its references remapped.
This method is used when you have modified a ReferenceMaker to add or delete references, and are loading old files. It gets called during the reference mapping process, after the Load() method is called. You determine what version is loading in the Load(), and store the version in a variable which you can look at in RemapRefOnLoad() to determine how to remap references. The default implementation of this method just returns the same value it is passed, so you don't need to implement it unless you have added or deleted references from your class. This method makes it a lot easier to load old files when the reference topology has changed.

Parameters
iref- The input index of the reference.
Returns
The output index of the reference.

Reimplemented from ReferenceMaker.

◆ Save()

virtual PFExport IOResult Save ( ISave isave)
virtual

Called for saving data.

Called by the system to allow the plugin to save its data.

Parameters
isave- This pointer may be used to call methods to write data to disk. See the section on Loading and Saving Plug-in Data for an overview of the load/save process.
Returns
The default implementation is return IO_OK.
  • IO_OK means the result was acceptable, with no errors.
  • IO_ERROR This should be returned if an error occurred.

Reimplemented from ReferenceMaker.

◆ Load()

virtual PFExport IOResult Load ( ILoad iload)
virtual

Called for loading data.

Called by the system to allow the plug-in to load its data. See the section on Loading and Saving Plug-in Data for an overview of the load - save process.

Parameters
iload- This interface pointer may be used to call methods to read data from disk.
Returns
The default implementation is return IO_OK.
  • IO_OK means the result was acceptable, with no errors.
  • IO_ERROR This should be returned if an error occurred.

Reimplemented from ReferenceMaker.

◆ NotifyTarget()

virtual PFExport void NotifyTarget ( int  message,
ReferenceMaker hMaker 
)
inlinevirtual

Sends messages to ReferenceTargets.

This method is available in release 4.0 and later only. Used by a ReferenceMaker to send 'reverse' notification messages to its ReferenceTargets, or to this ReferenceTarget.

Parameters
message- The message sent to the reference target.
hMaker- The ReferenceMaker sending the message.

Reimplemented from ReferenceTarget.

80{ SlateModelWrapper::RefMakerNotifyTarget( message, hMaker ); }

◆ GetCreateMouseCallBack()

virtual CreateMouseCallBack * GetCreateMouseCallBack ( )
inlinevirtual

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.

Returns
A pointer to an instance of a class derived from CreateMouseCallBack.

Implements BaseObject.

static PFExport OneClickCreateCallBack * Instance()

◆ OKToChangeTopology()

virtual BOOL OKToChangeTopology ( MSTR modName)
inlinevirtual

Implemented by the System.

This method is called to see if any modifiers down in the pipeline depend on topology. It sends the message REFMSG_IS_OK_TO_CHANGE_TOPOLOGY to see if any modifiers or objects down the pipeline depend on topology.

Parameters
modNameThis parameter is set to the dependent modifier's name if there is an item that depends on topology.
Returns
TRUE if it is okay to change the topology; FALSE if it is not okay to change the topology.

Reimplemented from BaseObject.

84{ return FALSE; }

◆ InitNodeName()

virtual void InitNodeName ( MSTR s)
inlinevirtual

Implemented by the System.

Sets the default node name to "Helper".

Reimplemented from HelperObject.

87{ s = GetObjectName(true); }
virtual const MCHAR * GetObjectName(bool localized=true) const =0

◆ Eval()

virtual ObjectState Eval ( TimeValue  t)
inlinevirtual

This method is called to evaluate the object and return the result as an ObjectState.

When the system has a pointer to an object it doesn't know if it's a procedural object or a derived object. So it calls Eval() on it and gets back an ObjectState. A derived object managed by the system may have to call Eval() on its input for example. A plug-in (like a procedural object) typically just returns itself. A plug-in that does not just return itself is the Morph Object (/MAXSDK/SAMPLES/OBJECTS/MORPHOBJ.CPP). This object uses a morph controller to compute a new object and fill in an ObjectState which it returns.

Parameters
tSpecifies the time to evaluate the object.
Returns
The result of evaluating the object as an ObjectState.
Sample Code:
Typically this method is implemented as follows:
{ return ObjectState(this); }
The ObjectState is the structure that flows up the geometry pipeline.
Definition: object.h:287

Implements Object.

88{ return ObjectState(this); }

◆ GetClassName()

virtual void GetClassName ( MSTR s,
bool  localized = true 
) const
inlineoverridevirtual

Retrieves the name of the plugin class.

This name is used in 3ds Max's UI and in MAXScript. For Material plug-ins this method is used to put up the material "type" name in the Material Editor.

Parameters
sReference to a string filled in with the name of the plugin class.
localizedIf true, then the class name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the class name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the class name in English.

Reimplemented from Animatable.

102{ UNUSED_PARAM(s); UNUSED_PARAM(localized); }
#define UNUSED_PARAM(x)
Definition: BuildWarnings.h:18

◆ ClassID()

virtual Class_ID ClassID ( )
inlinevirtual

Retrieves a constant that uniquely identifies the plugin class.

This method must return the unique ID for the plugin class. If two ClassIDs conflict, the system will only load the first conflicting one it finds. A program (gencid.exe) is provided to generate unique class id values.

Returns
A class id that uniquely identifies a plugin class
See also
Class ClassID, class ID definitions in plugapi.h.

Reimplemented from Animatable.

103{ return Class_ID(0,0); }
Definition: maxtypes.h:67

◆ BeginEditParams()

virtual void BeginEditParams ( IObjParam ip,
ULONG  flags,
Animatable prev 
)
pure virtual
Remarks
This method is called by the system when the user may edit the item's (object, modifier, controller, etc.) parameters.
Parameters
ipInterface 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.
flagsDescribe 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.

prevPointer 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 Animatable.

◆ EndEditParams()

virtual void EndEditParams ( IObjParam ip,
ULONG  flags,
Animatable next 
)
pure virtual
Remarks
This method is called when the user is finished editing an objects parameters. The system passes a flag into the EndEditParams() method to indicate if the rollup page should be removed. If this flag is TRUE, the plug-in must un-register the rollup page, and delete it from the panel.
Parameters
ipAn interface pointer. The developer may use the interface pointer to call methods such as DeleteRollupPage().

flagsThe following flag may be set:

END_EDIT_REMOVEUI
If TRUE, the item's user interface should be removed.

nextAnimatable 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 Animatable.

◆ Clone()

virtual RefTargetHandle Clone ( RemapDir remap)
pure virtual

This method is used by 3ds Max to clone an object.

See also
CloneRefHierarchy(), class RemapDir This method is called by 3ds Max to have the plugin clone itself. The plug-in's implementation of this method should copy both the data structure and all the data residing in the data structure of this reference target. The plugin should clone all its references as well. Also, the plug-in's implementation of this method must call BaseClone(). In order for classes derived from this class to clone cleanly, the Clone method should just create the new instance, and then call an implementation of BaseClone that clones the references and copies any other necessary data. For example:
class MyDerivedPlugin
: public MyBasePlugin
{
const int MY_REFERENCE = 1;
ReferenceTarget* Clone(RemapDir& remap)
{
ReferenceTarget* result = new MyDerivedPlugin();
BaseClone(this, result, remap);
return result;
}
void BaseClone(ReferenceTarget* from, ReferenceTarget* to, RemapDir& remap)
{
if (!to || !from || from == to)
return;
MyBasePlugin::BaseClone(from, to, remap);
to->ReplaceReference(MY_REFERENCE, remap->CloneRef(from->GetReference(MY_REFERENCE)));
}
};
virtual CoreExport RefTargetHandle GetReference(int i)
Returns the 'i-th' reference.
CoreExport RefResult ReplaceReference(int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
Used when cloning reference makers.
A scene entity that is being owned and listened to by other scene entities.
Definition: ref.h:1849
For remapping references during a Clone.
Definition: ref.h:830
virtual RefTargetHandle CloneRef(RefTargetHandle oldTarg)
Creates a clone of a reference target only if it hasn't been cloned already.

This method should not be directly called by plug-ins. Instead, either RemapDir::CloneRef() or CloneRefHierachy() should be used to perform cloning. These methods ensure that the mapping from the original object to the clone is added to the RemapDir used for cloning, which may be used during backpatch operations

Note
See the remarks in method BaseClone() below.
Parameters
remap- A RemapDir instance used for remapping references during a Clone.
Returns
A pointer to the cloned item.

Reimplemented from ReferenceTarget.

◆ GetObjectName()

virtual const MCHAR * GetObjectName ( bool  localized = true) const
pure virtual
Returns
the name that will appear in the modifier stack.
Parameters
localizedIf true, then the object name returned should be localized in the language 3ds Max is currently using. Otherwise it should be the object name in English. If a plugin does not provide localized string resources, it can disregard this parameter and always return the object name in English.

Reimplemented from BaseObject.

◆ Init()

virtual PFExport bool Init ( IObject pCont,
Object pSystem,
INode node,
Tab< Object * > &  actions,
Tab< INode * > &  actionNodes 
)
virtual

Returns true if the operation has been proceeded successfully.

The method is called when the ActionList is established the first time, when there is a first particle that enters the ActionList and there is a need to proceed particles. /param pCont: particle container with particle data /param pSystem: the particle system that generates the particle stream; the same operator may get calls from different particle systems; if the result varies according to the particle system that generates particles, then this parameter is useful. /param pNode: INode of the particle system that generates the particles. /param actions: Tab<Object*> of Actions in the current ActionList. The stack will be used to proceed particles. The stack is mutable: an Action may change the stack (to remove or add some Actions) to fine-tune the order of execution or add some extra actions. The next parameter should sync with the mutation. /param actionNodes: Tab<INode*> of action nodes.

Implements IPFAction.

◆ Release()

virtual PFExport bool Release ( IObject pCont)
virtual

See Init().

Implements IPFAction.

◆ SupportRand()

virtual bool SupportRand ( ) const
inlinevirtual

An Action may carry some chaos/unpredictibility in its processing.

This method supports chaos randomness.

Implements IPFAction.

134{ return false; }

◆ GetRand()

virtual int GetRand ( )
inlinevirtual

For chaos/unpredictibility action, gets rand value.

Implements IPFAction.

135{ return 0; }

◆ SetRand()

virtual void SetRand ( int  seed)
inlinevirtual

For chaos/unpredictibility action, sets rand value.

Implements IPFAction.

136{ ; }

◆ NewRand()

virtual PFExport int NewRand ( )
virtual

◆ ChannelsUsed()

virtual const ParticleChannelMask & ChannelsUsed ( const Interval time) const
pure virtual

See Init().

Implements IPFAction.

◆ ActivityInterval()

virtual const Interval ActivityInterval ( ) const
pure virtual

Casting the FPValue->ptr parameter to Tab<Interface_ID>* as in PFExport void ChannelsUsed(...); an Action may have a time interval when the Action is active.

Outside this interval the Action does nothing, therefore there is no need to proceed particles outside the activity interval.

Implements IPFAction.

◆ GetCurrentState()

virtual PFExport IObject * GetCurrentState ( IObject pContainer)
virtual

Returns action state (see IPFActionState.h for details).

You have to delete the IObject by DeleteIObject method when the state is no longer needed.

Reimplemented from IPFAction.

◆ SetCurrentState()

virtual PFExport void SetCurrentState ( IObject actionState,
IObject pContainer 
)
virtual

Sets the state of the action to the given state.

Reimplemented from IPFAction.

◆ NumPViewParamBlocks()

virtual int NumPViewParamBlocks ( ) const
inlinevirtual

Implements IPViewItem.

147{ return 1; } // the paramBlock

◆ GetPViewParamBlock()

virtual PFExport IParamBlock2 * GetPViewParamBlock ( int  i) const
virtual


Implements IPViewItem.

◆ GetClassDesc()

virtual ClassDesc * GetClassDesc ( ) const
pure virtual

◆ RefreshUI()

PFExport void RefreshUI ( WPARAM  message,
IParamMap2 map = NULL 
) const

◆ UpdatePViewUI()

PFExport void UpdatePViewUI ( ParamID  updateID) const

◆ pblock()

IParamBlock2 * pblock ( ) const
inline
158{ return m_pblock; }
IParamBlock2 * m_pblock
Definition: PFSimpleAction.h:167

◆ randLinker()

const RandObjLinker & randLinker ( ) const
inline
159{ return m_randLinker; }
RandObjLinker m_randLinker
Definition: PFSimpleAction.h:172

◆ _pblock()

IParamBlock2 *& _pblock ( )
inline
162{ return m_pblock; }

◆ _randLinker()

RandObjLinker & _randLinker ( )
inline
163{ return m_randLinker; }

Member Data Documentation

◆ m_pblock

IParamBlock2* m_pblock
protected

◆ m_randLinker

RandObjLinker m_randLinker
protected