This is a black box engine that takes some input and outputs some data. More...

#include <IMNMeshDataChannel.h>

Inheritance diagram for IDataChannelEngine:

Public Member Functions
virtual SClass_ID	SuperClassID ()
	All Data Channel engines are in this superclass. More...

virtual void	GetUIName (MSTR &name)=0
	Returns the name to be used in the UI for the Data Channel modifier. More...

virtual void	GetOperandInfo (MSTR &info)
	Returns the Operand Info to be used by the ui (uses Tooltip string by default) More...

virtual void	GetTooltip (MSTR &name)=0
	Returns the tooltip to be used by the ui. More...

virtual MaxSDK::Array< InputDataType >	InputRequirements ()=0
	Returns what this engine needs for data. More...

virtual MaxSDK::Array< OutputDataType >	OutputRequirements ()=0
	Returns what this engine outputs for data. More...

virtual MaxSDK::Array< ChannelType >	OutputChannelTypes ()=0
	Returns what channel the output data can written to NOTE only one output channel is supported and the first one is the only one applied to the mnmesh. More...

virtual IndexChannel	IndexChannelToBeUsed ()=0
	Vertex channels have an face index channel assigned to them. More...

virtual void	InputType (IOutputData data)
	This is called before the output requirements are called so the engine can respond to a change in the input type and adjust the output appropriately. More...

virtual bool	ValidConditions (MSTR &errorString)
	This lets the modifier know that the engine is in valid state with the input data. More...

virtual Interval	Process (TimeValue t, MaxSDK::Array< IInputData > &inData, MaxSDK::Array< IOutputData > &outData, int &tempPerInstanceData, PartID &channelsChanged)=0
	This does all the work. More...

virtual bool	HasDomain ()
	This allows engines that creates floats to define the domain of there values. More...

virtual float	DomainMin ()
	Returns the min value for the domain More...

virtual float	DomainMax ()
	Returns the max value for the domain More...

virtual bool	CustomDisplay ()
	This allows the engine to override the modifier display. More...

virtual int	Display (TimeValue t, INode inode, ViewExp vpt, int flagst, MaxSDK::Array< IOutputData > &outData)
	Same display from base object except outdata which is the data that the engine created in the process method More...

virtual void	BeginEditParams (IObjParam ip, ULONG flags, Animatable prev)=0
	Lets the engine bring up any UI that is needed. More...

virtual void	EndEditParams (IObjParam ip, ULONG flags, Animatable next)=0
	Lets the engine tear down any UI that is created. More...

void	SetPerInstanceData (MaxSDK::Array< int > *data)

virtual bool	ForceAsInputEngine ()

virtual bool	Threadable ()
	************ WIP FUTURE THREADING SUPPORT ************************** More...

virtual Interval	Threaded_Setup (TimeValue t, MaxSDK::Array< IInputData > &inData, MaxSDK::Array< IOutputData > &outData, int &tempPerInstanceData, PartID &channelsChanged)
	This is where all the non thread safe calls should be processed and cached before the Threaded_Process is called. More...

virtual Interval	Threaded_Process (const int startIndex, const int endIndex, TimeValue t, MaxSDK::Array< IInputData > &inData, MaxSDK::Array< IOutputData > &outData, int &tempPerInstanceData, PartID &channelsChanged)
	This does all the work. More...

Public Member Functions inherited from ReferenceTarget
virtual CoreExport void	GetClassName (MSTR &s, bool localized=true) const override
	Retrieves the name of the plugin class. More...

virtual BOOL	IsRefTarget ()
	Checks if this is a ReferenceTarget. More...

CoreExport RefResult	TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
	Tests for a cyclical reference. More...

CoreExport BOOL	HasDependents ()
	Checks if a ReferenceTarget has references. More...

CoreExport BOOL	HasRealDependents ()
	Checks if this has Real (Strong) Dependents. More...

void	BeginDependencyTest ()
	Starts Dependency Test. More...

BOOL	EndDependencyTest ()
	Ends Dependency Test. More...

virtual void	RefAdded (RefMakerHandle rm)
	Called after a reference is made to a target. More...

virtual void	RefAddedUndoRedo (RefMakerHandle rm)
	Called after a reference is made to a target because of undo or redo. More...

virtual void	RefDeleted ()
	Called after a references to this is deleted. More...

virtual void	RefDeletedUndoRedo ()
	Called after a references to this is deleted because of undo or redo. More...

CoreExport RefResult	DeleteAllRefsToMe ()
	Deletes all references to this ReferenceTarget. More...

CoreExport RefResult	TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
	Transfers all the references from oldTarget to this. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

virtual CoreExport RefTargetHandle	Clone (RemapDir &remap)
	This method is used by 3ds Max to clone an object. More...

virtual CoreExport void	BaseClone (ReferenceTarget from, ReferenceTarget to, RemapDir &remap)
	This method copies base class data from an object to its clone. More...

virtual CoreExport RefResult	NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=NULL, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS)
	Notify all dependent RefMakers concerned with the message. More...

void	FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
	This sends the REFMSG_FLAGDEPENDENTS message up the pipeline. More...

virtual void	NotifyForeground (TimeValue t)
	This method is called to flag dependents into the FG. More...

virtual void	NotifyTarget (int message, ReferenceMaker *hMaker)
	Sends messages to ReferenceTargets. More...

virtual CoreExport void *	GetInterface (ULONG id)
	Inherited from Animatable. More...

virtual CoreExport BaseInterface *	GetInterface (Interface_ID id)
	Inherited from Animatable. More...

CoreExport	ReferenceTarget ()
	Constructor. More...

virtual CoreExport RefResult	AutoDelete ()
	Deletes the object when it has no more real dependents. More...

CoreExport RefResult	MaybeAutoDelete ()
	Deletes the object when it has no more real dependents. More...

Public Member Functions inherited from ReferenceMaker
CoreExport RefResult	ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
	Used when cloning reference makers. More...

CoreExport RefResult	DeleteAllRefsFromMe ()
	Deletes all references from this ReferenceMaker. More...

CoreExport RefResult	DeleteAllRefs ()
	Deletes all references both to and from this item. More...

CoreExport RefResult	DeleteReference (int i)
	Deletes the specified reference. More...

virtual BOOL	CanTransferReference (int i)
	Tells whether this reference can be transfered. More...

CoreExport ReferenceSaveManager &	GetReferenceSaveManager ()
	Access the ReferenceSaveManager of this ReferenceMaker. More...

virtual CoreExport IOResult	Save (ISave *isave)
	Called for saving data. More...

virtual CoreExport IOResult	Load (ILoad *iload)
	Called for loading data. More...

virtual int	RemapRefOnLoad (int iref)
	Used to load old files with references. More...

virtual CoreExport void	RescaleWorldUnits (float f)
	Rescale size of all world units in reference hierarchy. More...

virtual CoreExport void	EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags)
	Enumerate auxiliary files (e.g. bitmaps) More...

virtual CoreExport void	SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
	The default save enumeration. More...

virtual CoreExport bool	SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
	Used to specify reference slot remapping during scene file save. More...

CoreExport int	DoEnumDependents (DependentEnumProc *dep)
	Begins an enumeration that searches back in the dependency network. More...

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

CoreExport int	FindRef (RefTargetHandle rtarg)
	Get the index of the ReferenceTarget. More...

virtual BOOL	IsRefMaker ()
	Tells whether it is a ReferenceMaker. More...

virtual BOOL	IsRealDependency (ReferenceTarget *rtarg)
	Returns whether this is a "real" (strong) dependency or not. More...

virtual BOOL	ShouldPersistWeakRef (RefTargetHandle rtarg)
	Specifies whether a weak reference is to be persisted on a partial load or save. More...

CoreExport	ReferenceMaker ()
	Constructor. More...

CoreExport void	DeleteMe ()
	Deletes an instance of this class. More...

virtual CoreExport int	NumRefs ()
	Returns the total number of references this ReferenceMaker can hold. More...

virtual CoreExport RefTargetHandle	GetReference (int i)
	Returns the 'i-th' reference. More...

Public Member Functions inherited from Animatable
virtual void	FreeCaches ()

virtual int	NumChildren ()

virtual Animatable *	ChildAnim (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 More...

virtual BOOL	SetKeyBufferPresent ()
	returns true if there is a "Set Key" buffer present More...

virtual CoreExport void	SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
	Commit any "Set Key" buffers on the given sub-anim. More...

virtual void	CommitSetKeyBuffer (TimeValue t)
	Commit any "Set Key" buffers. More...

virtual CoreExport void	SubAnimRevertSetKeyBuffer (int subNum)
	Revert any "Set Key" buffers on the given sub-anim. More...

virtual void	RevertSetKeyBuffer ()
	Revert any "Set Key" buffers. More...

virtual LRESULT CALLBACK	TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
	This function is obsolete. More...

virtual bool	IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
	Returns true if the passed description is being used. More...

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

CoreExport	Animatable ()
	Constructor. More...

virtual CoreExport void	DeleteThis ()
	Deletes an instance of this class. More...

virtual void	GetClassName (MSTR &s) MAX_SEALED

MSTR	ClassName (bool localized=true) const
	Returns the name of the plugin class. More...

virtual CoreExport Class_ID	ClassID ()
	Retrieves a constant that uniquely identifies the plugin class. More...

virtual CoreExport void	ReleaseInterface (ULONG id, void *i)

virtual CoreExport int	SetProperty (ULONG id, void *data)

virtual CoreExport void *	GetProperty (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. More...

CoreExport AnimProperty *	FindProperty (DWORD id)
	Find any property. More...

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

CoreExport AppDataChunk *	GetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Retrieves the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport BOOL	RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
	Deletes the application/plugin specific (custom) data stored with an Animatable. More...

CoreExport void	ClearAllAppData ()
	Deletes all application/plugin specific (custom) data stored with an Animatable. More...

virtual int	NumSubs ()

virtual Animatable *	SubAnim (int i)

virtual MSTR	SubAnimName (int i) MAX_SEALED

virtual CoreExport MSTR	SubAnimName (int i, bool localized)

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

virtual ParamDimension *	GetParamDimension (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. More...

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

virtual BOOL	IsSubCurveSelected (int subNum)
	Returns the selected state of the sub-curve whose index is passed. More...

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 TrackClipObject *	CopyTrack (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 TrackClipObject *	CopySubTrack (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. More...

CoreExport void	AddNoteTrack (NoteTrack *note)

CoreExport void	DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)

CoreExport BOOL	HasNoteTracks ()

CoreExport int	NumNoteTracks ()

CoreExport NoteTrack *	GetNoteTrack (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 More...

virtual CoreExport void	MouseCycleCompleted (TimeValue t)

virtual CoreExport void	MouseCycleStarted (TimeValue t)

virtual int	NumParamBlocks ()

virtual IParamBlock2 *	GetParamBlock (int i)

virtual IParamBlock2 *	GetParamBlockByID (short id)

CoreExport bool	SvSaveData (ISave *isave, USHORT id)

CoreExport bool	SvLoadData (ILoad *iLoad)

CoreExport DWORD	SvGetRefIndex ()

CoreExport void	SvSetRefIndex (DWORD i)

CoreExport bool	SvDeleteRefIndex ()

virtual CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager gom, Animatable owner, int id, DWORD flags)

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 MSTR	SvGetName (IGraphObjectManager gom, IGraphNode gNode, bool isBeingEdited)

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

virtual CoreExport bool	SvIsSelected (IGraphObjectManager gom, IGraphNode gNode)
	Returns true if the object is selected in its schematic view. More...

virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport COLORREF	SvHighlightColor (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	SvHandleDoubleClick (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager gom, IGraphNode gNode)

virtual CoreExport bool	SvCanSelect (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"... More...

virtual CoreExport bool	SvCanDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns true if this object can respond to the SvDetachRel(...) method... More...

virtual CoreExport bool	SvDetachRel (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Detach this relationship. More...

virtual CoreExport bool	SvHandleRelDoubleClick (IGraphObjectManager gom, IGraphNode gNodeTarget, int id, IGraphNode *gNodeMaker)
	Called when this relationship is double-clicked in the schematic view... More...

CoreExport ICustAttribContainer *	GetCustAttribContainer ()
	This method returns a pointer to the custom attributes container interface class. More...

CoreExport void	AllocCustAttribContainer ()
	This method allocates space for a custom attributes container. More...

CoreExport void	DeleteCustAttribContainer ()
	This method deletes space used by a custom attributes container. More...

void	SetAFlag (DWORD mask)

void	ClearAFlag (DWORD mask)
	Clears one or more bits in the Animatable flags. More...

bool	TestAFlag (DWORD mask) const
	Tests one or more bits in the Animatable flags. More...

void	SetAFlagEx (DWORD mask)
	Sets one or more bits in the Animatable extended flags. More...

void	ClearAFlagEx (DWORD mask)
	Clears one or more bits in the Animatable extended flags. More...

bool	TestAFlagEx (DWORD mask) const
	Tests one or more bits in the Animatable extended flags. More...

CoreExport bool	TestFlagBit (int index)
	Tests the specified flag bit. More...

CoreExport void	SetFlagBit (int index, bool newValue=true)
	Sets the specified flag bit. More...

CoreExport void	ClearFlagBit (int index)
	Clears the specified flag bit. More...

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

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

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

UtilExport BaseInterface *	GetInterface (Interface_ID id)

virtual UtilExport Interface_ID	GetID ()

virtual LifetimeType	LifetimeControl ()

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Protected Attributes
MaxSDK::Array< int > *	mPerTempInstanceData = nullptr
	A list of all the temporary per instance data used to handle UI. More...

Protected Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

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

Static Public Member Functions inherited from Animatable
static CoreExport BOOL	IsDeleted (Animatable *anim)
	Debug method to determine whether an object has been deleted. More...

static CoreExport AnimHandle	GetHandleByAnim (Animatable *anim)
	Get the unique handle for an Animatable object. More...

static CoreExport Animatable *	GetAnimByHandle (AnimHandle handle)
	Get an Animatable object from its unique handle. More...

static CoreExport AnimHandle	GetNextHandle ()
	Get the unique handle for the next Animatable object to be created. More...

static CoreExport void	EnumerateAllAnimatables (EnumAnimList &enumProcObject)
	Enumerator to enumerate across all animatables. More...

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

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

static CoreExport bool	RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Registers a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport bool	UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
	Unregisters a callback proc that is called when an AppDataChunk is read from a scene file. More...

static CoreExport int	RequestFlagBit ()
	Requests an unique flag bit index. More...

static CoreExport void	ReleaseFlagBit (int index)
	Releases the flag bit index. More...

static CoreExport void	ClearFlagBitInAllAnimatables (int index)
	Clears the specified flag bit in all Animatables. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0

Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep)
	Method to perform an enumeration on a ReferenceTarget. More...

virtual CoreExport	~ReferenceTarget ()=0
	Destructor. More...

Protected Member Functions inherited from ReferenceMaker
virtual RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
	Receives and responds to messages. More...

virtual CoreExport	~ReferenceMaker ()=0
	Destructor. More...

virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. More...

void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target. More...

void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target. More...

int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target. More...

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

Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor. More...

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Detailed Description

This is a black box engine that takes some input and outputs some data.

For the DataChannel modifier the input is an MNMesh and Node and the output can be vertex, edge or face channel data. Engines come in 3 flavors an Input Engine which does not use kType_Stack_Input and just generates a channel, a Operand Engine which takes an input channel and generates an output channel, and finally an Output Engine which does not generate an output channel and usually pushes that stack data (input) to the MNMesh

Member Function Documentation

◆ SuperClassID()

virtual SClass_ID SuperClassID ( )

inlinevirtual

All Data Channel engines are in this superclass.

Reimplemented from ReferenceTarget.

282 { return DATACHANNELENGINE_SUPER_CLASS_ID; }

DATACHANNELENGINE_SUPER_CLASS_ID

#define DATACHANNELENGINE_SUPER_CLASS_ID

IDataChannelEngine super-class ID.

Definition: plugapi.h:459

◆ GetUIName()

virtual void GetUIName ( MSTR & name )

pure virtual

Returns the name to be used in the UI for the Data Channel modifier.

Parameters

name	the name to be used in the Data Channel Modifier

◆ GetOperandInfo()

virtual void GetOperandInfo ( MSTR & info )

inlinevirtual

Returns the Operand Info to be used by the ui (uses Tooltip string by default)

289 { GetTooltip(info); }

MaxSDK::ChannelData::IDataChannelEngine::GetTooltip

virtual void GetTooltip(MSTR &name)=0

Returns the tooltip to be used by the ui.

◆ GetTooltip()

virtual void GetTooltip ( MSTR & name )

pure virtual

Returns the tooltip to be used by the ui.

◆ InputRequirements()

virtual MaxSDK::Array<InputDataType> InputRequirements ( )

pure virtual

Returns what this engine needs for data.

◆ OutputRequirements()

virtual MaxSDK::Array<OutputDataType> OutputRequirements ( )

pure virtual

Returns what this engine outputs for data.

Per instance data can be stored here also though if you change the requirements existing data may be deleted

◆ OutputChannelTypes()

virtual MaxSDK::Array<ChannelType> OutputChannelTypes ( )

pure virtual

Returns what channel the output data can written to NOTE only one output channel is supported and the first one is the only one applied to the mnmesh.

◆ IndexChannelToBeUsed()

virtual IndexChannel IndexChannelToBeUsed ( )

pure virtual

Vertex channels have an face index channel assigned to them.

This returns what face index channel the output data is associated with. Only applies if the output channel is a vertex channel

◆ InputType()

virtual void InputType ( IOutputData data )

inlinevirtual

This is called before the output requirements are called so the engine can respond to a change in the input type and adjust the output appropriately.

Only an engine that requires an input channel from the stack ie has an input channel set to kType_Stack_Input needs to listen to this

Parameters

data	is the channel containing the stack array coming in from the stack in response from the kType_Stack_Input flag set as an input requirement

306 {UNUSED_PARAM(data);};

UNUSED_PARAM

#define UNUSED_PARAM(x)

Definition: BuildWarnings.h:18

◆ ValidConditions()

virtual bool ValidConditions ( MSTR & errorString )

inlinevirtual

This lets the modifier know that the engine is in valid state with the input data.

For instance if the input type changed to a data that was not supported it can send an error message to the user that this is not a valid case

Parameters

errorString is a string describing why the engine failed

311 { UNUSED_PARAM(errorString);return true; };

◆ Process()

virtual Interval Process	(	TimeValue	t,
		MaxSDK::Array< IInputData > &	inData,
		MaxSDK::Array< IOutputData > &	outData,
		int &	tempPerInstanceData,
		PartID &	channelsChanged
	)

pure virtual

This does all the work.

It takes the input data and then fills out the output data

Parameters

t	the time that the data is to be processed
inData	the data
outData	where the output data is stored
tempPerInstanceData	is a flag that can be used to signal UI commands for the process. So the UI can set all the flags in mPerTempInstanceData array then in the Process can check the tempPerInstanceData and test and clear it.
channelsChanged	are the parts of the MNMesh that have changed flowing up the stack to the modifier to the engine used to rebuild/update any cached data the engine may have created. Returns the interval that the outdata is good for

◆ HasDomain()

virtual bool HasDomain ( )

inlinevirtual

This allows engines that creates floats to define the domain of there values.

This gives the display some hints on how to gradiate the color

325 { return false; }

◆ DomainMin()

virtual float DomainMin ( )

inlinevirtual

Returns the min value for the domain

327 { return -1.0E38f; }

◆ DomainMax()

virtual float DomainMax ( )

inlinevirtual

Returns the max value for the domain

329 { return 1.0E38f; }

◆ CustomDisplay()

virtual bool CustomDisplay ( )

inlinevirtual

This allows the engine to override the modifier display.

Return true and implement display if you want a custom display

334 { return false; }

◆ Display()

virtual int Display	(	TimeValue	t,
		INode *	inode,
		ViewExp *	vpt,
		int	flagst,
		MaxSDK::Array< IOutputData > &	outData
	)

inlinevirtual

Same display from base object except outdata which is the data that the engine created in the process method

336 { UNUSED_PARAM(t); UNUSED_PARAM(inode); UNUSED_PARAM(vpt); UNUSED_PARAM(flagst); UNUSED_PARAM(outData); return 1; }

◆ BeginEditParams()

virtual void BeginEditParams	(	IObjParam *	ip,
		ULONG	flags,
		Animatable *	prev
	)

pure virtual

Lets the engine bring up any UI that is needed.

Reimplemented from Animatable.

◆ EndEditParams()

virtual void EndEditParams	(	IObjParam *	ip,
		ULONG	flags,
		Animatable *	next
	)

pure virtual

Lets the engine tear down any UI that is created.

Reimplemented from Animatable.

◆ SetPerInstanceData()

void SetPerInstanceData ( MaxSDK::Array< int > * data )

inline

347 { mPerTempInstanceData = data; }

MaxSDK::ChannelData::IDataChannelEngine::mPerTempInstanceData

MaxSDK::Array< int > * mPerTempInstanceData

A list of all the temporary per instance data used to handle UI.

Definition: IMNMeshDataChannel.h:396

◆ ForceAsInputEngine()

virtual bool ForceAsInputEngine ( )

inlinevirtual

352 { return false; }

◆ Threadable()

virtual bool Threadable ( )

inlinevirtual

************** WIP FUTURE THREADING SUPPORT ****************************

This returns whether the engine is thread safe. If the engine is not thread safe only the Process will be called. If all the engines in the stack are thread safe first the engine Threaded_Setup is called on all the engines sequentially to allow for non thread safe operatiuons to be called and cached like getvalue, getobjecttm etc. This lets the engines do any non thread safe operations. Then the engines Threaded_Process will be called on a block of data that the engine is to proces. NOTE operands that write directly to the mnmesh are not thread safe and typically output operands are not thread safe

362 { return false; }

◆ Threaded_Setup()

virtual Interval Threaded_Setup	(	TimeValue	t,
		MaxSDK::Array< IInputData > &	inData,
		MaxSDK::Array< IOutputData > &	outData,
		int &	tempPerInstanceData,
		PartID &	channelsChanged
	)

inlinevirtual

This is where all the non thread safe calls should be processed and cached before the Threaded_Process is called.

All the channel allocations should be done here.

Parameters

t	the time that the data is to be processed
inData	the data
outData	where the output data is stored
tempPerInstanceData	is a flag that can be used to signal UI commands for the process. So the UI can set all the flags in mPerTempInstanceData array then in the Process can check the tempPerInstanceData and test and clear it.
channelsChanged	are the parts of the MNMesh that have changed flowing up the stack to the modifier to the engine used to rebuild/update any cached data the engine may have created. Returns the interval that the outdata is good for

373 { UNUSED_PARAM(t); UNUSED_PARAM(inData); UNUSED_PARAM(outData); UNUSED_PARAM(tempPerInstanceData); UNUSED_PARAM(channelsChanged); return FOREVER; };

FOREVER

#define FOREVER

Definition: interval.h:168

◆ Threaded_Process()

virtual Interval Threaded_Process	(	const int	startIndex,
		const int	endIndex,
		TimeValue	t,
		MaxSDK::Array< IInputData > &	inData,
		MaxSDK::Array< IOutputData > &	outData,
		int &	tempPerInstanceData,
		PartID &	channelsChanged
	)

inlinevirtual

This does all the work.

It takes the input data and then fills out the output data. This allows for more efficient threeding insteading each engine doing it own threading. The threading is vertical instead of horizontal allowing for more scalability has the stack grows.

Parameters

startIndex	is the output channel element that you should begin working on
endIndex	is the output channel element that you should stop working on
t	the time that the data is to be processed
inData	the data
outData	where the output data is stored
tempPerInstanceData	is a flag that can be used to signal UI commands for the process. So the UI can set all the flags in mPerTempInstanceData array then in the Process can check the tempPerInstanceData and test and clear it.
channelsChanged	are the parts of the MNMesh that have changed flowing up the stack to the modifier to the engine used to rebuild/update any cached data the engine may have created. Returns the interval that the outdata is good for

387 { UNUSED_PARAM(startIndex); UNUSED_PARAM(endIndex); UNUSED_PARAM(t); UNUSED_PARAM(inData); UNUSED_PARAM(outData); UNUSED_PARAM(tempPerInstanceData); UNUSED_PARAM(channelsChanged); return FOREVER; };

Member Data Documentation

◆ mPerTempInstanceData

MaxSDK::Array<int>* mPerTempInstanceData = nullptr

protected

A list of all the temporary per instance data used to handle UI.

Since the UI is tied to the single instance but there can be multiple local data which needs to be processed this can let you mark which local data has been processed. The life time of the data the pointer's points to is managed by the Data Channel Modifier's local data

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SuperClassID()

◆ GetUIName()

◆ GetOperandInfo()

◆ GetTooltip()

◆ InputRequirements()

◆ OutputRequirements()

◆ OutputChannelTypes()

◆ IndexChannelToBeUsed()

◆ InputType()

◆ ValidConditions()

◆ Process()

◆ HasDomain()

◆ DomainMin()

◆ DomainMax()

◆ CustomDisplay()

◆ Display()

◆ BeginEditParams()

◆ EndEditParams()

◆ SetPerInstanceData()

◆ ForceAsInputEngine()

◆ Threadable()

◆ Threaded_Setup()

◆ Threaded_Process()

Member Data Documentation

◆ mPerTempInstanceData