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

#include <mxsPlugin.h>

+ Inheritance diagram for MSPluginSimpleMeshMod:

Public Member Functions

 MSPluginSimpleMeshMod ()
 
 MSPluginSimpleMeshMod (MSPluginClass *pc, BOOL loading)
 
 ~MSPluginSimpleMeshMod ()
 
int HitTest (TimeValue t, INode *inode, int type, int crossing, int vflags, IPoint2 *p, ViewExp *vpt) override
 This method is called to determine if the specified screen point intersects the item.
 
int Display (TimeValue t, INode *inode, ViewExp *vpt, int vflags) override
 This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
 
void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box) override
 This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
 
void GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box) override
 This is the object space bounding box, the box in the object's local coordinates.
 
void Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt) override
 Checks the point passed for a snap and updates the SnapInfo structure.
 
BOOL HasUVW () override
 Call this method to find out if the object has UVW coordinates.
 
void SetGenUVW (BOOL sw) override
 This method is called to change the state of its Generate UVW boolean.
 
BOOL ChangeTopology () override
 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.
 
Interval GetValidity (TimeValue t)
 
RefTargetHandle Clone (RemapDir &remap) override
 This method is used by 3ds Max to clone an object.
 
Interval LocalValidity (TimeValue t) override
 This method returns the validity interval of a modifier.
 
ChannelMask ChannelsUsed () override
 These are channels that the modifier needs in order to perform its modification.
 
ChannelMask ChannelsChanged () override
 These are the channels that the modifier actually modifies.
 
void NotifyInputChanged (const Interval &changeInt, PartID partID, RefMessage message, ModContext *mc) override
 This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents().
 
void ModifyObject (TimeValue t, ModContext &mc, ObjectState *os, INode *node) override
 This is the method that actually modifies the input object.
 
BOOL DependOnTopology (ModContext &mc) override
 Modifiers that place a dependency on topology should return TRUE for this method.
 
Class_ID InputType () override
 This is the type of object that the modifier knows how to modify.
 
- Public Member Functions inherited from MSPluginModifier
 MSPluginModifier ()
 
 MSPluginModifier (MSPluginClass *pc, BOOL loading)
 
 ~MSPluginModifier ()
 
void DeleteThis () override
 Deletes an instance of this class.
 
HWND AddRollupPage (HINSTANCE hInst, const MCHAR *dlgTemplate, DLGPROC dlgProc, const MCHAR *title, LPARAM param=0, DWORD vflags=0, int category=ROLLUP_CAT_STANDARD) override
 
void DeleteRollupPage (HWND hRollup) override
 
IRollupWindowGetRollupWindow () override
 
void RollupMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam) override
 
ReferenceTargetget_delegate () override
 
void GetClassName (MSTR &s, bool localized) const override
 Retrieves the name of the plugin class.
 
Class_ID ClassID () override
 Retrieves a constant that uniquely identifies the plugin class.
 
SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
void FreeCaches () override
 
int NumSubs () override
 
AnimatableSubAnim (int i) override
 
MSTR SubAnimName (int i, bool localized=true) override
 
int NumParamBlocks () override
 
IParamBlock2GetParamBlock (int i) override
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
IParamBlock2GetParamBlockByID (BlockID id) override
 
voidGetInterface (ULONG id) override
 
RefResult NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate) override
 Receives and responds to messages.
 
int NumRefs () override
 Returns the total number of references this ReferenceMaker can hold.
 
RefTargetHandle GetReference (int i) override
 Returns the 'i-th' reference.
 
void RefDeleted (RefMakerHandle rm) override
 
void RefAdded (RefMakerHandle rm) override
 Called after a reference is made to a target.
 
void RefAddedUndoRedo (RefMakerHandle rm) override
 Called after a reference is made to a target because of undo or redo.
 
void RefDeletedUndoRedo (RefMakerHandle rm) override
 Called after a reference to this is deleted because of undo or redo.
 
RefTargetHandle Clone (RemapDir &remap) override
 This method is used by 3ds Max to clone an object.
 
IOResult Save (ISave *iSave) override
 
IOResult Load (ILoad *iLoad) override
 Called for loading data.
 
void NotifyTarget (int msg, RefMakerHandle rm) override
 
const MCHARGetObjectName (bool localized=true) const override
 
void BeginEditParams (IObjParam *objParam, ULONG vflags, Animatable *pPrev) override
 
void EndEditParams (IObjParam *objParam, ULONG vflags, Animatable *pNext) override
 
int HitTest (TimeValue t, INode *inode, int type, int crossing, int vflags, IPoint2 *p, ViewExp *vpt) override
 This method is called to determine if the specified screen point intersects the item.
 
int Display (TimeValue t, INode *inode, ViewExp *vpt, int vflags) override
 This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).
 
void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box) override
 This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).
 
void GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box) override
 This is the object space bounding box, the box in the object's local coordinates.
 
void Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt) override
 Checks the point passed for a snap and updates the SnapInfo structure.
 
CreateMouseCallBackGetCreateMouseCallBack () override
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
 
BOOL HasUVW () override
 Call this method to find out if the object has UVW coordinates.
 
void SetGenUVW (BOOL sw) override
 This method is called to change the state of its Generate UVW boolean.
 
Interval LocalValidity (TimeValue t) override
 This method returns the validity interval of a modifier.
 
ChannelMask ChannelsUsed () override
 These are channels that the modifier needs in order to perform its modification.
 
ChannelMask ChannelsChanged () override
 These are the channels that the modifier actually modifies.
 
void NotifyInputChanged (const Interval &changeInt, PartID partID, RefMessage message, ModContext *mc) override
 This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents().
 
void ModifyObject (TimeValue t, ModContext &mc, ObjectState *os, INode *node) override
 This is the method that actually modifies the input object.
 
BOOL DependOnTopology (ModContext &mc) override
 Modifiers that place a dependency on topology should return TRUE for this method.
 
Class_ID InputType () override
 This is the type of object that the modifier knows how to modify.
 
bool AnyObjectFilter (Object *object) const override
 When InputType() returns anyObjectClassID, this method is used to determine whether the modifier can be applied to a specific object.
 
IOResult SaveLocalData (ISave *iSave, LocalModData *ld) override
 When a 3ds Max file is being saved, this method is called so that the modifier can save the localData structure that is hung off each ModContext.
 
IOResult LoadLocalData (ILoad *iLoad, LocalModData **pld) override
 When a 3ds Max file is being loaded, this method is called so that the modifier can load the LocalModData structure that is hung off each ModContext.
 
- Public Member Functions inherited from MSPlugin
 MSPlugin ()
 
virtual ~MSPlugin ()
 
void init (MSPluginClass *pClass)
 
ScripterExport void gc_trace () override
 
ScripterExport void collect () override
 
void DeleteThis ()
 
void init_locals ()
 
void call_handler (Value *handler, Value **arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)
 
Value_call_handler (Value *handler, Value **arg_list, int count, TimeValue t, BOOL disable_on_error=FALSE)
 
FPStatus call_handler (const MCHAR *handler_name, FPParams *params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)
 
FPStatus call_handler (Value *handler, FPParams *params, FPValue &result, TimeValue t, BOOL disable_on_error=FALSE)
 
void post_create (ReferenceTarget *me, BOOL loading)
 
void call_all_set_handlers ()
 
void disable ()
 
void enable ()
 
BOOL enabled ()
 
int get_local_index (Value *prop)
 
Valueget_local (int index)
 
void set_local (int index, Value *val)
 
ScripterExport IParamBlock2GetParamBlockByID (BlockID id)
 
virtual HWND AddRollupPage (HINSTANCE hInst, const MCHAR *dlgTemplate, DLGPROC dlgProc, const MCHAR *title, LPARAM param=0, DWORD vflags=0, int category=ROLLUP_CAT_STANDARD)=0
 
virtual void DeleteRollupPage (HWND hRollup)=0
 
virtual IRollupWindowGetRollupWindow ()=0
 
virtual void RollupMouseMessage (HWND hDlg, UINT message, WPARAM wParam, LPARAM lParam)=0
 
ScripterExport RefResult NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)
 
ScripterExport RefTargetHandle clone_from (MSPlugin *obj, ReferenceTarget *obj_as_ref, RemapDir &remap)
 
void RefAdded (RefMakerHandle rm)
 
ScripterExport void RefDeleted (RefMakerHandle rm)
 
void NotifyTarget (int msg, RefMakerHandle rm)
 
virtual ReferenceTargetget_delegate ()=0
 
IOResult Save (ISave *isave) override
 
IOResult Load (ILoad *iLoad)
 
void post_load (ILoad *iLoad, int which)
 
void dump_local_vars_and_externals (int indentLevel)
 
- Public Member Functions inherited from Value
virtual ScripterExport BOOL is_kind_of (ValueMetaClass *c)
 
virtual ScripterExport ValueMetaClasslocal_base_class ()
 
virtual Valueeval ()
 
virtual Valueeval_no_wrapper ()
 
virtual ScripterExport Valueapply (Value **arglist, int count, CallContext *cc=nullptr)
 
virtual ScripterExport Valueapply_no_alloc_frame (Value **arglist, int count, CallContext *cc=nullptr)
 
virtual void export_to_scripter ()
 
virtual Valuemap (node_map &m)
 
virtual Valuemap_path (PathName *path, node_map &m)
 
virtual Valuefind_first (BOOL(*test_fn)(INode *node, int level, const void *arg), const void *test_arg)
 
virtual Valueget_path (PathName *path)
 
virtual ScripterExport void sprin1 (CharStream *stream)
 
virtual ScripterExport void sprint (CharStream *stream)
 
virtual void prin1 ()
 
virtual void print ()
 
virtual Class_ID get_max_class_id ()
 
virtual Valuedelete_vf (Value **arglist, int arg_count)
 
virtual ValueclearSelection_vf (Value **arglist, int arg_count)
 
virtual float to_float ()
 
virtual double to_double ()
 
virtual const MCHARto_string ()
 
virtual MSTR to_mstr ()
 
virtual MSTR to_filename ()
 
virtual int to_int ()
 
virtual INT64 to_int64 ()
 
virtual INT_PTR to_intptr ()
 
virtual BOOL to_bool ()
 
virtual BitArrayto_bitarray ()
 
virtual Point4 to_point4 ()
 
virtual Point3 to_point3 ()
 
virtual Point2 to_point2 ()
 
virtual AColor to_acolor ()
 
virtual COLORREF to_colorref ()
 
virtual INodeto_node ()
 
virtual Ray to_ray ()
 
virtual Interval to_interval ()
 
virtual Quat to_quat ()
 
virtual AngAxis to_angaxis ()
 
virtual Matrix3to_matrix3 ()
 
virtual Box3 to_box3 ()
 
virtual float * to_eulerangles ()
 
virtual Mtlto_mtl ()
 
virtual Texmapto_texmap ()
 
virtual MtlBaseto_mtlbase ()
 
virtual Modifierto_modifier ()
 
virtual TimeValue to_timevalue ()
 
virtual Controlto_controller ()
 
virtual Atmosphericto_atmospheric ()
 
virtual Effectto_effect ()
 
virtual IMultiPassCameraEffectto_mpassCamEffect ()
 
virtual ShadowTypeto_shadowtype ()
 
virtual FilterKernelto_filter ()
 
virtual INodeto_rootnode ()
 
virtual ITrackViewNodeto_trackviewnode ()
 
virtual NURBSIndependentPointto_nurbsindependentpoint ()
 
virtual NURBSPointto_nurbspoint ()
 
virtual NURBSObjectto_nurbsobject ()
 
virtual NURBSControlVertexto_nurbscontrolvertex ()
 
virtual NURBSCurveto_nurbscurve ()
 
virtual NURBSCVCurveto_nurbscvcurve ()
 
virtual NURBSSurfaceto_nurbssurface ()
 
virtual NURBSTexturePointto_nurbstexturepoint ()
 
virtual NURBSSetto_nurbsset ()
 
virtual ReferenceTargetto_reftarg ()
 
virtual Meshto_mesh ()
 
virtual BezierShapeto_beziershape ()
 
virtual Thunkto_thunk ()
 
virtual void to_fpvalue (FPValue &v)
 
virtual Rendererto_renderer ()
 
virtual Box2to_box2 ()
 
virtual NURBSTextureSurfaceto_nurbstexturesurface ()
 
virtual NURBSDisplayto_nurbsdisplay ()
 
virtual TessApproxto_tessapprox ()
 
virtual Valuewiden_to (Value *arg, Value **arg_list)
 
virtual BOOL comparable (Value *arg)
 
virtual BOOL special_case_compare (Value *arg, bool &specialCaseCompareResult)
 
virtual ScripterExport Valuedeep_copy (HashTable *remapper)
 
virtual BOOL is_const ()
 
virtual ScripterExport Valueget_property (Value **arg_list, int count)
 
virtual ScripterExport Valueset_property (Value **arg_list, int count)
 
ScripterExport Value_get_property (Value *prop)
 
virtual ScripterExport Value_set_property (Value *prop, Value *val)
 
virtual Valueget_container_property (Value *prop, Value *cur_prop)
 
virtual Valueset_container_property (Value *prop, Value *val, Value *cur_prop)
 
virtual BOOL _is_collection ()
 
virtual BOOL _is_charstream ()
 
virtual BOOL _is_rolloutcontrol ()
 
virtual BOOL _is_rolloutthunk ()
 
virtual BOOL _is_function ()
 
virtual BOOL _is_selection ()
 
virtual BOOL _is_thunk ()
 
virtual BOOL _is_indirect_thunk ()
 
virtual SelectionIteratorselection_iterator ()
 
virtual ScripterExport IOResult Save (ISave *isave)
 
virtual void drop_MAX_refs ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
ScripterExport Valuemake_heap_permanent ()
 
ScripterExport Valuemake_heap_static ()
 
ScripterExport Valueget_heap_ptr ()
 
ScripterExport Valueget_stack_heap_ptr ()
 
ScripterExport Valuemigrate_to_heap ()
 
ScripterExport Valueget_live_ptr ()
 
virtual BOOL object_supports_case_sensitive_names ()
 
ScripterExport Value_get_property (Value *prop, Value *prop_name_as_parsed)
 
ScripterExport Value_set_property (Value *prop, Value *val, Value *prop_name_as_parsed)
 
virtual ScripterExport Valueget_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
virtual ScripterExport Valueset_case_sensitive_property (Value **arg_list, int count, const TCHAR *case_sensitive_name)
 
ScripterExport Valueinvoke_getter_case_sensitive_property (Value *target, getter_vf getter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
 
ScripterExport Valueinvoke_setter_case_sensitive_property (Value *target, setter_vf setter, Value **arg_list, int count, const TCHAR *case_sensitive_name, const TCHAR *nested_prop_case_sensitive_name)
 
- Public Member Functions inherited from Collectable
ScripterExport Collectable ()
 
virtual ScripterExport ~Collectable ()
 
ScripterExport voidoperator new (size_t sz, char flag)
 
ScripterExport voidoperator new (size_t sz)
 
ScripterExport void operator delete (void *val)
 
ScripterExport void operator delete (void *val, char flag)
 
virtual void collect ()=0
 
virtual ScripterExport void gc_trace ()
 
ScripterExport bool derives_from_Animatable ()
 
virtual BOOL derives_from_MAXWrapper ()
 
ScripterExport void make_collectable ()
 
void make_permanent ()
 
void make_static ()
 
int is_marked ()
 
int is_not_marked ()
 
int is_garbage ()
 
int is_permanent ()
 
void mark_in_use ()
 
void unmark_in_use ()
 
int has_heap_copy ()
 
int is_in_heap ()
 
int is_on_stack ()
 
- Public Member Functions inherited from Modifier
CoreExport Modifier ()
 
CoreExport ~Modifier ()
 
 __declspec (deprecated) virtual MSTR GetName() MAX_SEALED
 
SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
virtual void ForceNotify (Interval &i) override
 Notifies dependents of a change.
 
CoreExport SvGraphNodeReference SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags) override
 
CoreExport MSTR SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited) override
 
CoreExport bool SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport bool SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name) override
 
CoreExport bool SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport COLORREF SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport bool SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode) override
 Returns true if the object is selected in its schematic view.
 
CoreExport MultiSelectCallbackSvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport bool SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport bool SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport bool SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild) override
 
CoreExport bool SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild) override
 
CoreExport bool SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode) override
 
CoreExport bool SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode) override
 Called when the user deletes this object in the schematic view...
 
virtual CoreExport MSTR GetName (bool localized) const
 Implemented by the System.
 
virtual CoreExport void SetName (MSTR n)
 Implemented by the System.
 
virtual void DisableModApps ()
 This method is used internally.
 
virtual void EnableModApps ()
 This method is used internally.
 
virtual CoreExport void DisableMod ()
 Implemented by the System.
 
virtual CoreExport void EnableMod ()
 Implemented by the System.
 
virtual int IsEnabled ()
 Implemented by the System.
 
virtual CoreExport void DisableModInViews ()
 Implemented by the System.
 
virtual CoreExport void EnableModInViews ()
 Implemented by the System.
 
virtual int IsEnabledInViews ()
 Implemented by the System.
 
virtual CoreExport void DisableModInRender ()
 Implemented by the System.
 
virtual CoreExport void EnableModInRender ()
 Implemented by the System.
 
virtual int IsEnabledInRender ()
 Implemented by the System.
 
virtual bool ChangesSelType ()
 If a modifier want to make it possible to switch dynamically between changing the selection type that flows up the stack, or leaving it like it is, it can overwrite this.
 
virtual CoreExport ChannelMask TotalChannelsUsed ()
 Returns the same value as ChannelsUsed() above except GFX_DATA_CHANNEL will be ORed in if the TOPO_CHANNEL or the TEXMAP_CHANNEL are being used.
 
virtual CoreExport ChannelMask TotalChannelsChanged ()
 Returns the same value as ChannelsChanged() above except GFX_DATA_CHANNEL will be ORed in if the TOPO_CHANNEL, the TEXMAP_CHANNEL , or the VERTCOLOR_CHANNEL are being changed.
 
CoreExport IOResult Save (ISave *isave) override
 Implemented by the System.
 
CoreExport IOResult Load (ILoad *iload) override
 Implemented by the System.
 
virtual bool ShouldCollapseOnSave ()
 In cases where a modifier does not exist in the specified save version returned by GetSavingVersion(), or where a modifier employs new functionality which cannot be retained in the specified save version, it may return true to indicate that the owning object should be saved in a state with its modifier stack collapsed at least up to this modifier.
 
virtual CoreExport void EnumModContexts (ModContextEnumProc *proc)
 Implemented by the System.
 
virtual CoreExport void GetIDerivedObject (ModContext *mc, IDerivedObject *&derObj, int &modIndex)
 This method will retrieve the IDerivedObject and index of this modifier for a given modifier context.
 
virtual CoreExport void CopyAdditionalChannels (Object *fromObj, Object *toObj)
 In case the modifier changes the object type (basically the os->obj pointer in ModifyObject) and changes the ExtensionChannel, it has to overwrite this method and copy only the channels that it doesn't modify/added already to the new object.
 
CoreExport INodeGetNodeFromModData (LocalModData *data, int &index)
 This function allows modifiers to find the nodes they are modifying.
 
CoreExport INodeGetNodeFromModContext (ModContext *mc, int &index)
 This function allows modifiers to find the nodes they are modifying.
 
- 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 void SetExtendedDisplay (int flags)
 This method is used for storing mode-dependent display attributes.
 
 __declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
 
virtual CoreExport BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System.
 
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 BOOL HasUVW (int mapChannel)
 Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
 
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.
 
 __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
 
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.
 
virtual void NotifyTarget (int message, ReferenceMaker *hMaker)
 Sends messages to ReferenceTargets.
 
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 int RemapRefOnLoad (int iref)
 Used to load old files with references.
 
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 BOOL CanDeleteSubAnim (int i)
 
virtual void DeleteSubAnim (int i)
 
virtual DWORD GetSubAnimCurveColor (int subNum)
 
virtual int SubNumToRefNum (int subNum)
 
virtual BOOL CanCopyAnim ()
 
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 ParamDimensionGetParamDimension (int i)
 
virtual BOOL SelectSubAnim (int subNum)
 
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 CoreExport BOOL IsAnimated ()
 
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 SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport COLORREF SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
 
virtual CoreExport bool SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
 
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 ()
 

Static Public Member Functions

static RefTargetHandle create (MSPluginClass *pc, BOOL loading)
 
- Static Public Member Functions inherited from MSPluginModifier
static RefTargetHandle create (MSPluginClass *pc, BOOL loading)
 
- Static Public Member Functions inherited from Collectable
static ScripterExport void for_all_values (void(*map_fn)(Value *val), ValueMapper *mapper=nullptr, ValueMetaClass *c=nullptr)
 
static void mark ()
 
static void sweep ()
 
static void setup (size_t)
 
static ScripterExport void gc ()
 
static void coalesce_free_list ()
 
static void close_down ()
 
static void drop_maxwrapper_refs ()
 
static ScripterExport void push_alloc_stack_frame ()
 
static ScripterExport void pop_alloc_stack_frame ()
 
static ScripterExport ULONGLONG get_num_values_created ()
 
static ScripterExport bool validate_value_linkages ()
 
- Static Public Member Functions inherited from Modifier
static CoreExport bool GetInputType (ClassDesc *cd, Class_ID &inputType)
 To determine the input type of a modifier, an instance of the modifier needs to be created.
 
- 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.
 

Public Attributes

IObjParamip
 
Matrix3Valuetransform
 
Matrix3ValueinverseTransform
 
Point3Valuemin
 
Point3Valuemax
 
Point3Valuecenter
 
Point3Valueextent
 
Box3Valuebbox
 
- Public Attributes inherited from MSPluginModifier
IObjParamip
 
- Public Attributes inherited from MSPlugin
MSPluginClasspc
 
Value ** locals
 
short flags
 
int version
 
ReferenceTargetref
 
Tab< IParamBlock2 * > pblocks
 
ILoadiload
 
- Public Attributes inherited from Value
ValueMetaClasstag
 
- Public Attributes inherited from Collectable
Collectablenext
 
Collectableprev
 
byte flags
 
byte flags2
 
short flags3
 

Additional Inherited Members

- Static Public Attributes inherited from Collectable
static CRITICAL_SECTION heap_update
 
static Collectablecollectable_list
 
static Collectablepermanent_list
 
static free_memfree_list [GC_NUM_SUBLISTS]
 
static size_t heap_allocated
 
static size_t heap_size
 
static ScripterExport collectable_state state
 
static ScripterExport bool fullCollectNextHoldFlush
 
static bool gc_light
 
static bool in_gc
 
static HANDLE hGCCompletedEvent
 
- Static Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 
- Protected Member Functions inherited from MSPluginModifier
void SetReference (int i, RefTargetHandle rtarg) override
 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 Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray mRenderItemHandles
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 
- Static Protected Attributes inherited from Value
static ScripterExport Valuekeyarg_marker_value
 

Constructor & Destructor Documentation

◆ MSPluginSimpleMeshMod() [1/2]

1985{ }

◆ MSPluginSimpleMeshMod() [2/2]

MSPluginSimpleMeshMod ( MSPluginClass pc,
BOOL  loading 
)

◆ ~MSPluginSimpleMeshMod()

Member Function Documentation

◆ create()

static RefTargetHandle create ( MSPluginClass pc,
BOOL  loading 
)
static

◆ HitTest()

int HitTest ( TimeValue  t,
INode inode,
int  type,
int  crossing,
int  flags,
IPoint2 p,
ViewExp vpt 
)
inlineoverridevirtual

This method is called to determine if the specified screen point intersects the item.

The method returns nonzero if the item was hit; otherwise 0.

Parameters
tThe time to perform the hit test.
inodeA pointer to the node to test.
typeThe type of hit testing to perform. See Scene and Node Hit Test Types. for details.
crossingThe state of the crossing setting. If TRUE crossing selection is on.
flagsThe hit test flags. See Scene and Node Hit Testing Flags for details.
pThe screen point to test.
vptAn interface pointer that may be used to call methods associated with the viewports.
Returns
Nonzero if the item was hit; otherwise 0.

Reimplemented from MSPluginModifier.

1990{ return 0; }

◆ Display()

int Display ( TimeValue  t,
INode inode,
ViewExp vpt,
int  flags 
)
inlineoverridevirtual

This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM).

Note: For this method to be called the object's validity interval must be invalid at the specified time t. If the interval is valid, the system may not call this method since it thinks the display is already valid.

Parameters
tThe time to display the object.
inodeThe node to display.
vptAn interface pointer that may be used to call methods associated with the viewports.
flagsSee Display Flags.
Returns
Default return value is -1, means this object doesn't have display function. 0 means it didn't draw anything in current frame. Otherwise return positive values..

Reimplemented from MSPluginModifier.

1991{ return 0; }

◆ GetWorldBoundBox()

void GetWorldBoundBox ( TimeValue  t,
INode inode,
ViewExp vp,
Box3 box 
)
inlineoverridevirtual

This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version).

The bounding box returned by this method does not need to be precise. It should however be calculated rapidly. The object can handle this by transforming the 8 points of its local bounding box into world space and take the minimums and maximums of the result. Although this isn't necessarily the tightest bounding box of the objects points in world space, it is close enough.

Parameters
tThe time to compute the bounding box.
inodeThe node to calculate the bounding box for.
vpAn interface pointer that can be used to call methods associated with the viewports.
boxContains the returned bounding box.

Reimplemented from MSPluginModifier.

1992{ }

◆ GetLocalBoundBox()

void GetLocalBoundBox ( TimeValue  t,
INode inode,
ViewExp vp,
Box3 box 
)
inlineoverridevirtual

This is the object space bounding box, the box in the object's local coordinates.

The system expects that requesting the object space bounding box will be fast.

Parameters
tThe time to retrieve the bounding box.
inodeThe node to calculate the bounding box for.
vpAn interface pointer that may be used to call methods associated with the viewports.
boxContains the returned bounding box.

Reimplemented from MSPluginModifier.

1993{ }

◆ Snap()

void Snap ( TimeValue  t,
INode inode,
SnapInfo snap,
IPoint2 p,
ViewExp vpt 
)
inlineoverridevirtual

Checks the point passed for a snap and updates the SnapInfo structure.

Note
Developers wanting to find snap points on an Editable Mesh object should see the method XmeshSnap::Snap() in /MAXSDK/SAMPLES/SNAPS/XMESH/XMESH.CPP.
Parameters
tThe time to check.
inodeThe node to check.
snapThe snap info structure to update.
pThe screen point to check.
vptAn interface pointer that may be used to call methods associated with the viewports.

Reimplemented from MSPluginModifier.

1994{ }

◆ HasUVW()

BOOL HasUVW ( )
overridevirtual

Call this method to find out if the object has UVW coordinates.

This method returns TRUE if the object has UVW coordinates; otherwise FALSE. In 3ds Max 2.0 and later there is code in the renderer that will automatically turn on the UVW coordinates of the base object if UV's are missing (and needed). The base object has to implement two simple methods to make this work: HasUVW() and SetGenUVW(). Developers are encouraged to put these methods in their objects: it makes using the program easier for the user. If they are not implemented, it doesn't cause any real harm: it will just operate as before and put up the missing UVW's message. Here is how the procedural sphere implements these methods:

BOOL SphereObject::GetGenUVW()
{
BOOL genUVs;
pblock->GetValue(PB_GENUVS, 0, genUVs, v);
return genUVs;
}
void SphereObject::SetGenUVW(BOOL sw)
{
if (sw==GetGenUVW()) return;
pblock->SetValue(PB_GENUVS,0, sw);
}
Definition: interval.h:36

Important Note: The pblock->SetValue() will cause a call to NotifyDependents(FOREVER, PART_TEXMAP, REFMSG_CHANGE), which will invalidate the UVW cache. It is essential that this call be made, so if the 'generate UVW' boolean is not handled by a parameter block, then NotifyDependents() needs to be called explicitly. Also Note: For "modifiable objects" that pass up the pipeline getting modified, such as TriObject, EditTriObject, etc., which cannot generate their own UVWs, but can carry them in their data structures, only this HasUVW() method needs to be implemented. For example, here is the implementation for TriObject: BOOL TriObject::HasUVW() { return mesh.tvFace?1:0; }

Reimplemented from MSPluginModifier.

◆ SetGenUVW()

void SetGenUVW ( BOOL  sw)
overridevirtual

This method is called to change the state of its Generate UVW boolean.

If the state changes, the object must send a REFMSG_CHANGE up the pipeline by calling NotifyDependents(). This applies to map channel 1.

Parameters
swThe new state for the generate UVW flag.

Reimplemented from MSPluginModifier.

◆ ChangeTopology()

BOOL ChangeTopology ( )
inlineoverridevirtual

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.

When an item is selected for editing, and there is a modifier in the pipeline that depends on topology, the system calls this method to see if it may potentially change the topology. If this method returns TRUE the system will put up a warning message indicating that a modifier exists in the stack that depends on topology.

Reimplemented from BaseObject.

1997{return TRUE;}

◆ GetValidity()

Interval GetValidity ( TimeValue  t)

◆ Clone()

RefTargetHandle Clone ( RemapDir remap)
overridevirtual

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 MSPluginModifier.

◆ LocalValidity()

Interval LocalValidity ( TimeValue  t)
overridevirtual

This method returns the validity interval of a modifier.

It is simply the combination of the validity of all the modifier's parameters. It's used to determine when to cache in the pipeline, but is not directly responsible for determining when ModifyObject() is called. ModifyObject() is called when the pipeline needs to be evaluated either because someone sent a REFMSG_CHANGE message or the validity of the object does not include the current time.

If a modifier is not animated it's OK to simply return FOREVER from
this method. In the case where the modifier changes because a user changes a non-animated control in the user interface (for instance a check box), you can cause reevaluation by notifying your dependents of the change, i.e.:
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.
#define REFMSG_CHANGE
Sent to dependents of a ReferenceTarget that has changed in some way.
Definition: ref.h:251
const PartID PART_ALL
Combination of ALL_CHANNELS and PART_TM.
Definition: ref.h:92
#define FOREVER
Definition: interval.h:168
Parameters
tThe time to calculate the Interval.
See also
Advanced Topics on Intervals.

Reimplemented from MSPluginModifier.

◆ ChannelsUsed()

ChannelMask ChannelsUsed ( )
inlineoverridevirtual

These are channels that the modifier needs in order to perform its modification.

This should at least include the channels specified in ChannelsChanged() but may include more. Note that ChannelsUsed() is called many times but the channels returned should not change on the fly.

Returns
The channels required. See Object Channels.
Sample Code:
const ChannelMask TOPO_CHANNEL
The topology channel - the face or polygon structures.
Definition: channels.h:44
const ChannelMask GEOM_CHANNEL
The vertices of the object.
Definition: channels.h:47

Reimplemented from MSPluginModifier.

2003 {
2005 }
const ChannelMask SUBSEL_TYPE_CHANNEL
The current level of selection.
Definition: channels.h:65
const ChannelMask VERTCOLOR_CHANNEL
The color per vertex channel.
Definition: channels.h:72
const ChannelMask SELECT_CHANNEL
The sub-object selection channel.
Definition: channels.h:58
const ChannelMask TEXMAP_CHANNEL
The texture vertices and procedural mappings.
Definition: channels.h:49

◆ ChannelsChanged()

ChannelMask ChannelsChanged ( )
inlineoverridevirtual

These are the channels that the modifier actually modifies.

Note that ChannelsChanged() is called many times but the channels returned should not change on the fly.

Returns
The channels that are changed. See Object Channels

Reimplemented from MSPluginModifier.

◆ NotifyInputChanged()

void NotifyInputChanged ( const Interval changeInt,
PartID  partID,
RefMessage  message,
ModContext mc 
)
inlineoverridevirtual

This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE message via NotifyDependents().

Consider the following example: Assume the modifier stack contains a Sphere Object, then a Bend, then a Edit Mesh. The Edit Mesh modifier does not have a reference to the Bend or the Sphere because it does not officially depend on these items. However it does depend on them in a certain sense, because it modifies the data that these items produce. So, if they change it may affect the modifier. A modifier may build a cache based on its input object. The modifier needs a way to know when to discard this cache because the input object has changed. Whenever one of the items before this modifier in the stack sends out a REFMSG_CHANGE message via NotifyDependents() to indicate it has changed this method is called. The modifier may respond in a way appropriate to it, for example by discarding its cache of the input object. It is not legal, to issue a NotifyDependent()'s in the NotifyInputChanged() method of a modifier, without checking for reentrancy. Imagine, you have an instanced modifier applied to the same object in the stack. Sending a refmsg from the NotifyInputChanged method will cause an endless loop. Simply putting a guard in, that checks for reentrancy should get rid of the problem.

Parameters
changeIntThis is the interval from the message. It is reserved for future use - now it will always be FOREVER.
partIDThis is the partID from the message.
messageThis is the message sent.
mcThe ModContext for the pipeline that changed. If a modifier is applied to multiple objects, then there are ModApps in each pipeline that it is applied to. These ModApps are pointing to the same modifier. Consider the following example: Say you apply a Bend modifier to a Sphere, a Cylinder and a Box object. There are three ModApps but only one Bend modifier. Then you go to the Sphere and adjust its Radius. This will cause NotifyInputChanged() to be called on the Bend because the Bend's input changed. However only one of its inputs changed - only the Sphere changed and not the Cylinder or the Box. Therefore NotifyInputChanged() will be called once, and the ModContext passed in will be for the Sphere's changed pipeline. It is possible that all three objects could change at the same time. If an instanced float controller was assigned to the radius, width, and height - one parameter for each object - then the controller was adjusted in the function curve editor, all three items would change. In this case NotifyInputChanged() would be called three times on the Bend. Once for each pipeline, once with each ModContext.

Reimplemented from MSPluginModifier.

2010{ Modifier::NotifyInputChanged(changeInt, partID, message, mc); }
virtual void NotifyInputChanged(const Interval &changeInt, PartID partID, RefMessage message, ModContext *mc)
This method is called when an item in the modifier stack before this modifier sends a REFMSG_CHANGE m...
Definition: object.h:5586

◆ ModifyObject()

void ModifyObject ( TimeValue  t,
ModContext mc,
ObjectState os,
INode node 
)
overridevirtual

This is the method that actually modifies the input object.

This method is responsible for altering the object and then updating the validity interval of the object to reflect the validity of the modifier.

Parameters
tThe time at which the modification is being done.
mcA reference to the ModContext.
osThe object state flowing through the pipeline. This contains a pointer to the object to modify.
nodeThe node the modifier is applied to. This parameter is always NULL for Object Space Modifiers and non-NULL for World Space Modifiers (Space Warps). This is because a given WSM is only applied to a single node at a time whereas an OSM may be applied to several nodes. This may be used for example by particle system space warps to get the transformation matrix of the node at various times.
See also
The topic on Modifiers in the Programmers Guide.

Reimplemented from MSPluginModifier.

◆ DependOnTopology()

BOOL DependOnTopology ( ModContext mc)
inlineoverridevirtual

Modifiers that place a dependency on topology should return TRUE for this method.

An example would be a modifier that stores a selection set base on vertex indices. This modifier depends on the indices being intact for it to operate correctly.

Parameters
mcReference to the ModContext.
Returns
TRUE if the modifier depends on topology; otherwise FALSE.

Reimplemented from MSPluginModifier.

2020{ return Modifier::DependOnTopology(mc); }
virtual BOOL DependOnTopology(ModContext &mc)
Modifiers that place a dependency on topology should return TRUE for this method.
Definition: object.h:5623

◆ InputType()

Class_ID InputType ( )
inlineoverridevirtual

This is the type of object that the modifier knows how to modify.

Simple modifiers that just modify points of an object can operate on generic 'Deformable' objects. Deformable objects are any type of object that has points. A modifier could also work on a particular type of object such as a TriObject or PatchObject.

Returns
The Class_ID of the item. You can request any Class_ID for your input type. For example, Class_ID(OMNI_LIGHT_CLASS_ID, 0). See Class IDs defined in plugapi.h>.

Reimplemented from MSPluginModifier.

2022{ return triObjectClassID; }
CoreExport Class_ID triObjectClassID

Member Data Documentation

◆ ip

IObjParam* ip

◆ transform

Matrix3Value* transform

◆ inverseTransform

Matrix3Value* inverseTransform

◆ min

◆ max

◆ center

Point3Value* center

◆ extent

Point3Value* extent

◆ bbox

Box3Value* bbox