3ds Max C++ API Reference
IScanRenderer2 Class Referenceabstract

#include <IScanRenderer.h>

+ Inheritance diagram for IScanRenderer2:

Public Types

enum  {
  get_mapping , set_mapping , get_shadows , set_shadows ,
  get_autoReflect , set_autoReflect , get_forceWire , set_forceWire ,
  get_antialias , set_antialias , get_filter , set_filter ,
  get_objMotBlur , set_objMotBlur , get_velMotBlur , set_velMotBlur ,
  get_applyVelBlurEnv , set_applyVelBlurEnv , get_velBlurTrans , set_velBlurTrans ,
  get_memFrugal , set_memFrugal , get_pixelSamplerEnable , set_pixelSamplerEnable ,
  get_wireThickness , set_wireThickness , get_objBlurDuration , set_objBlurDuration ,
  get_velBlurDuration , set_velBlurDuration , get_antiAliasFilterSz , set_antiAliasFilterSz ,
  get_NBlurSamples , set_NBlurSamples , get_NBlurFrames , set_NBlurFrames ,
  get_autoReflLevels , set_autoReflLevels , get_colorClampType , set_colorClampType ,
  get_antiAliasFilter , set_antiAliasFilter , get_enableSSE , set_enableSSE ,
  get_globalSamplerEnabled , set_globalSamplerEnabled , get_globalSamplerClassByName , set_globalSamplerClassByName ,
  get_globalSamplerSampleMaps , set_globalSamplerSampleMaps , get_globalSamplerQuality , set_globalSamplerQuality ,
  get_globalSamplerAdaptive , set_globalSamplerAdaptive , get_globalSamplerAdaptiveThresh , set_globalSamplerAdaptiveThresh ,
  get_globalSamplerParam1 , set_globalSamplerParam1 , get_globalSamplerParam2 , set_globalSamplerParam2
}
 
- Public Types inherited from Renderer
enum class  PauseSupport { None , Full , Legacy }
 Returns whether pause is supported by this renderer. More...
 
enum  Requirement {
  kRequirement_NoVFB = 1 , kRequirement_DontSaveRenderOutput = 2 , kRequirement_Wants32bitFPOutput = 3 , kRequirement_WantsObjectSelection = 4 ,
  kRequirement_NoGBufferForToneOpPreview = 5 , kRequirement_SupportsConcurrentRendering = 6
}
 Returns true if the renderer has the given requirement, or returns false otherwise. More...
 
- Public Types inherited from BaseInterface
enum  LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }
 

Public Member Functions

 PROP_FNS (get_mapping, GetMapping, set_mapping, SetMapping, TYPE_BOOL)
 
 PROP_FNS (get_shadows, GetShadows, set_shadows, SetShadows, TYPE_BOOL)
 
 PROP_FNS (get_autoReflect, GetAutoReflect, set_autoReflect, SetAutoReflect, TYPE_BOOL)
 
 PROP_FNS (get_forceWire, GetForceWire, set_forceWire, SetForceWire, TYPE_BOOL)
 
 PROP_FNS (get_antialias, GetAntialias, set_antialias, SetAntialias, TYPE_BOOL)
 
 PROP_FNS (get_filter, GetFilter, set_filter, SetFilter, TYPE_BOOL)
 
 PROP_FNS (get_objMotBlur, GetObjMotBlur, set_objMotBlur, SetObjMotBlur, TYPE_BOOL)
 
 PROP_FNS (get_velMotBlur, GetVelMotBlur, set_velMotBlur, SetVelMotBlur, TYPE_BOOL)
 
 PROP_FNS (get_applyVelBlurEnv, GetApplyVelBlurEnv, set_applyVelBlurEnv, SetApplyVelBlurEnv, TYPE_BOOL)
 
 PROP_FNS (get_velBlurTrans, GetVelBlurTrans, set_velBlurTrans, SetVelBlurTrans, TYPE_BOOL)
 
 PROP_FNS (get_memFrugal, GetMemFrugal, set_memFrugal, SetMemFrugal, TYPE_BOOL)
 
 PROP_FNS (get_pixelSamplerEnable, GetPixelSamplerEnable, set_pixelSamplerEnable, SetPixelSamplerEnable, TYPE_BOOL)
 
 PROP_FNS (get_wireThickness, GetWireThickness, set_wireThickness, SetWireThickness, TYPE_FLOAT)
 
 PROP_FNS (get_objBlurDuration, GetObjBlurDuration, set_objBlurDuration, SetObjBlurDuration, TYPE_FLOAT)
 
 PROP_FNS (get_velBlurDuration, GetVelBlurDuration, set_velBlurDuration, SetVelBlurDuration, TYPE_FLOAT)
 
 PROP_FNS (get_antiAliasFilterSz, GetAntiAliasFilterSz, set_antiAliasFilterSz, SetAntiAliasFilterSz, TYPE_FLOAT)
 
 PROP_FNS (get_NBlurSamples, GetNBlurSamples, set_NBlurSamples, SetNBlurSamples, TYPE_INT)
 
 PROP_FNS (get_NBlurFrames, GetNBlurFrames, set_NBlurFrames, SetNBlurFrames, TYPE_INT)
 
 PROP_FNS (get_autoReflLevels, GetAutoReflLevels, set_autoReflLevels, SetAutoReflLevels, TYPE_INT)
 
 PROP_FNS (get_colorClampType, GetColorClampType, set_colorClampType, SetColorClampType, TYPE_INT)
 
 PROP_FNS (get_antiAliasFilter, GetAntiAliasFilter, set_antiAliasFilter, SetAntiAliasFilterRT, TYPE_REFTARG)
 
 PROP_FNS (get_enableSSE, IsSSEEnabled, set_enableSSE, SetEnableSSE, TYPE_BOOL)
 
 PROP_FNS (get_globalSamplerEnabled, GetGlobalSamplerEnabled, set_globalSamplerEnabled, SetGlobalSamplerEnabled, TYPE_BOOL)
 
 PROP_FNS (get_globalSamplerClassByName, GetGlobalSamplerClassByName, set_globalSamplerClassByName, SetGlobalSamplerClassByName, TYPE_TSTR_BV)
 
 PROP_FNS (get_globalSamplerSampleMaps, GetGlobalSamplerSampleMaps, set_globalSamplerSampleMaps, SetGlobalSamplerSampleMaps, TYPE_BOOL)
 
 PROP_FNS (get_globalSamplerQuality, GetGlobalSamplerQuality, set_globalSamplerQuality, SetGlobalSamplerQuality, TYPE_FLOAT)
 
 PROP_FNS (get_globalSamplerAdaptive, GetGlobalSamplerAdaptive, set_globalSamplerAdaptive, SetGlobalSamplerAdaptive, TYPE_BOOL)
 
 PROP_FNS (get_globalSamplerAdaptiveThresh, GetGlobalSamplerAdaptiveThresh, set_globalSamplerAdaptiveThresh, SetGlobalSamplerAdaptiveThresh, TYPE_FLOAT)
 
 PROP_FNS (get_globalSamplerParam1, GetGlobalSamplerParam1, set_globalSamplerParam1, SetGlobalSamplerParam1, TYPE_FLOAT)
 
 PROP_FNS (get_globalSamplerParam2, GetGlobalSamplerParam2, set_globalSamplerParam2, SetGlobalSamplerParam2, TYPE_FLOAT)
 
FPInterfaceDescGetDesc ()
 
void SetAntiAliasFilterRT (ReferenceTarget *op)
 
virtual float GetWireThickness ()=0
 
virtual void SetColorClampType (int i)=0
 
virtual int GetColorClampType ()=0
 
virtual float GetObjBlurDuration ()=0
 
virtual int GetNBlurSamples ()=0
 
virtual int GetNBlurFrames ()=0
 
virtual float GetVelBlurDuration ()=0
 
virtual void SetApplyVelBlurEnv (BOOL b)=0
 
virtual BOOL GetApplyVelBlurEnv ()=0
 
virtual void SetVelBlurTrans (BOOL b)=0
 
virtual BOOL GetVelBlurTrans ()=0
 
virtual int GetAutoReflLevels ()=0
 
virtual void SetMemFrugal (BOOL b)=0
 
virtual BOOL GetMemFrugal ()=0
 
virtual void SetEnableSSE (BOOL b)=0
 
virtual BOOL IsSSEEnabled ()=0
 
virtual BOOL GetGlobalSamplerEnabled ()=0
 
virtual void SetGlobalSamplerEnabled (BOOL enable)=0
 
virtual MSTR GetGlobalSamplerClassByName ()=0
 
virtual void SetGlobalSamplerClassByName (const MSTR)=0
 
virtual BOOL GetGlobalSamplerSampleMaps ()=0
 
virtual void SetGlobalSamplerSampleMaps (BOOL enable)=0
 
virtual float GetGlobalSamplerQuality ()=0
 
virtual void SetGlobalSamplerQuality (float f)=0
 
virtual BOOL GetGlobalSamplerAdaptive ()=0
 
virtual void SetGlobalSamplerAdaptive (BOOL enable)=0
 
virtual float GetGlobalSamplerAdaptiveThresh ()=0
 
virtual void SetGlobalSamplerAdaptiveThresh (float f)=0
 
virtual float GetGlobalSamplerParam1 ()=0
 
virtual void SetGlobalSamplerParam1 (float f)=0
 
virtual float GetGlobalSamplerParam2 ()=0
 
virtual void SetGlobalSamplerParam2 (float f)=0
 
- Public Member Functions inherited from IScanRenderer
virtual void SetAntialias (BOOL b)=0
 Sets the 'Anti-Aliasing' setting of the renderer to the value passed. More...
 
virtual BOOL GetAntialias ()=0
 Returns TRUE if anti-aliasing is on; FALSE if off. More...
 
virtual void SetFilter (BOOL b)=0
 Sets the 'Filter Maps' setting to the value passed. More...
 
virtual BOOL GetFilter ()=0
 Returns TRUE if Filter Maps is on; FALSE if off. More...
 
virtual void SetShadows (BOOL b)=0
 Sets the 'Shadows' setting to the value passed. More...
 
virtual BOOL GetShadows ()=0
 Returns TRUE if the rendering of shadow is on; FALSE if off. More...
 
virtual void SetMapping (BOOL b)=0
 Sets the 'Mapping' setting to the value passed. More...
 
virtual BOOL GetMapping ()=0
 Returns TRUE if the Mapping setting is on; FALSE if off. More...
 
virtual void SetForceWire (BOOL b)=0
 Sets the 'Force Wireframe' setting to the value passed. More...
 
virtual BOOL GetForceWire ()=0
 Returns TRUE if Force Wire is on; FALSE if off. More...
 
virtual void SetAutoReflect (BOOL b)=0
 Sets the 'Auto-Reflect/Refract and Mirrors' setting to the value passed. More...
 
virtual BOOL GetAutoReflect ()=0
 Returns TRUE if auto reflect is on; FALSE if off. More...
 
virtual void SetObjMotBlur (BOOL b)=0
 Sets Object Motion Blur to on or off. More...
 
virtual BOOL GetObjMotBlur ()=0
 Returns TRUE if object motion blur is on; FALSE if off. More...
 
virtual void SetVelMotBlur (BOOL b)=0
 Sets Velocity Motion Blur to on or off. More...
 
virtual BOOL GetVelMotBlur ()=0
 Returns TRUE if velocity motion blur is on; FALSE if off. More...
 
virtual void SetAutoReflLevels (int n)=0
 Sets the Auto Reflect/Refract Maps Rendering Iterations setting to the value passed. More...
 
virtual void SetWireThickness (float t)=0
 Sets the ''Wire Thickness' setting to the value passed. More...
 
virtual void SetObjBlurDuration (float dur)=0
 
virtual void SetVelBlurDuration (float dur)=0
 
virtual void SetNBlurFrames (int n)=0
 Sets the Motion Blur Duration setting to the value passed. More...
 
virtual void SetNBlurSamples (int n)=0
 Sets the Object Motion Blur Samples setting to the value passed. More...
 
virtual void SetMaxRayDepth (int n)=0
 Sets the '3ds Max Quadtree Depth' setting for Ray-Traced shadows to the value passed. More...
 
virtual int GetMaxRayDepth ()
 
virtual void SetAntiAliasFilter (FilterKernel *pKernel)=0
 
virtual FilterKernelGetAntiAliasFilter ()=0
 
virtual void SetAntiAliasFilterSz (float size)=0
 
virtual float GetAntiAliasFilterSz ()=0
 
virtual void SetPixelSamplerEnable (BOOL on)=0
 
virtual BOOL GetPixelSamplerEnable ()=0
 
- Public Member Functions inherited from Renderer
SClass_ID SuperClassID ()
 Returns the super class ID RENDERER_CLASS_ID. More...
 
virtual int Open (INode *scene, INode *vnode, ViewParams *viewPar, RendParams &rp, HWND hwnd, DefaultLight *defaultLights=NULL, int numDefLights=0, RendProgressCallback *prog=NULL)=0
 Called once and only once per render operation; used to initialize the renderer before rendering a sequence of frames. More...
 
virtual int Render (TimeValue t, Bitmap *tobm, FrameRendParams &frp, HWND hwnd, RendProgressCallback *prog=NULL, ViewParams *viewPar=NULL)=0
 Called to render a single frame. More...
 
virtual void Close (HWND hwnd, RendProgressCallback *prog=NULL)=0
 Called once and only once per render operation; used to free any resources allocated by Open() or Render(). More...
 
virtual bool ApplyRenderEffects (TimeValue t, Bitmap *pBitmap, bool updateDisplay=true)
 This method is called to apply the render effects at the specified time value. More...
 
virtual RendParamDlgCreateParamDialog (IRendParams *ir, BOOL prog=FALSE)=0
 This method is called to create and return a pointer to an instance of the RendParamDlg class. More...
 
virtual void ResetParams ()=0
 This method simply sets all the parameters to their default values. More...
 
virtual int GetAAFilterSupport ()
 
virtual bool SupportsTexureBaking ()
 Renderers which support texture baking should override this method to return true. More...
 
virtual bool SupportsCustomRenderPresets ()
 A renderer should override this method to return true if it supports any custom preset categories beyond the standard categories. More...
 
virtual int RenderPresetsFileVersion ()
 Return a number indicating the current version of the renderer's custom preset. More...
 
virtual BOOL RenderPresetsIsCompatible (int version)
 Return true if the renderer can load presets of the indicated version. More...
 
virtual const MCHARRenderPresetsMapIndexToCategory (int catIndex)
 Returns the UI name of a supported custom category. More...
 
virtual int RenderPresetsMapCategoryToIndex (const MCHAR *category)
 Returns the index of a supported custom category. More...
 
virtual int RenderPresetsPreSave (ITargetedIO *root, BitArray saveCategories)
 called before a render preset is saved. More...
 
virtual int RenderPresetsPostSave (ITargetedIO *, BitArray)
 called after a preset is saved. More...
 
virtual int RenderPresetsPreLoad (ITargetedIO *root, BitArray saveCategories)
 called before a preset is loaded. More...
 
virtual int RenderPresetsPostLoad (ITargetedIO *root, BitArray loadCategories)
 called after a preset is loaded. More...
 
virtual bool CompatibleWithAnyRenderElement () const =0
 Returns whether this renderer plugin is compatible with the given render element. More...
 
virtual bool CompatibleWithRenderElement (IRenderElement &pIRenderElement) const =0
 Returns whether this renderer plugin is compatible with the given render element. More...
 
virtual IInteractiveRenderGetIInteractiveRender ()=0
 This method returns a pointer to an IInteractiveRender, the interface used to perform interactive rendering (aka Active Shade). More...
 
virtual void GetVendorInformation (MSTR &info) const =0
 Platform information concerning the renderer. More...
 
virtual void GetPlatformInformation (MSTR &info) const =0
 Platform information concerning the renderer. More...
 
virtual bool IsStopSupported () const =0
 Returns true if and only the renderer supports the stop functionality, in which case the Stop button will be displayed in the render progress dialog, and StopRendering() may be called. More...
 
virtual void StopRendering ()=0
 Called to instruct the renderer to stop rendering. More...
 
virtual PauseSupport IsPauseSupported () const =0
 Returns whether pause is supported by this renderer. More...
 
virtual void PauseRendering ()=0
 Requests that the renderer pauses itself, at which point it should stop rendering and free CPU resources until a resume is requested. More...
 
virtual void ResumeRendering ()=0
 Requests that the renderer resumes rendering, following a call to PauseRendering(). More...
 
virtual bool HasRequirement (Requirement requirement)=0
 Returns true if the renderer has the given requirement, or returns false otherwise. 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 voidGetInterface (ULONG id)
 Inherited from Animatable. More...
 
virtual CoreExport BaseInterfaceGetInterface (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 ReferenceSaveManagerGetReferenceSaveManager ()
 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 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 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 void BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
 
virtual void EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
 
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. More...
 
CoreExport AnimPropertyFindProperty (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 AppDataChunkGetAppDataChunk (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 AnimatableSubAnim (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 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. 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 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. More...
 
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 More...
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
virtual int NumParamBlocks ()
 
virtual IParamBlock2GetParamBlock (int i)
 
virtual IParamBlock2GetParamBlockByID (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 MultiSelectCallbackSvGetMultiSelectCallback (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 ICustAttribContainerGetCustAttribContainer ()
 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 FPMixinInterface
 FPMixinInterface ()
 
virtual LifetimeType LifetimeControl ()
 
virtual CoreExport bool RegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
virtual void UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
 
CoreExport ~FPMixinInterface ()
 
virtual BaseInterfaceGetInterface (Interface_ID id)
 
virtual FPInterfaceDescGetDescByID (Interface_ID id)
 
virtual Interface_ID GetID ()
 
- Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPParams *params)
 
virtual CoreExport FPStatus Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
 
virtual FPStatus Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
 
virtual CoreExport FunctionID FindFn (const MCHAR *name)
 
virtual CoreExport BOOL IsEnabled (FunctionID actionID)
 
virtual CoreExport BOOL IsChecked (FunctionID actionID)
 
virtual CoreExport BOOL IsVisible (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsEnabled (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsChecked (FunctionID actionID)
 
virtual CoreExport FunctionID GetIsVisible (FunctionID actionID)
 
virtual ActionTableGetActionTable ()
 
virtual void EnableActions (BOOL onOff)
 
- Public Member Functions inherited from BaseInterface
virtual UtilExport ~BaseInterface ()
 Destructor. More...
 
virtual BaseInterfaceAcquireInterface ()
 
virtual void ReleaseInterface ()
 
virtual void DeleteInterface ()
 
virtual BaseInterfaceCloneInterface (void *remapDir=nullptr)
 

Additional Inherited Members

- 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 AnimatableGetAnimByHandle (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 voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
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. More...
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects. More...
 
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. More...
 
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. More...
 
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. 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 voidoperator 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 voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary. More...
 
static UtilExport voidaligned_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
 
- Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc nullInterface
 
- 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 ()
 
- Protected Member Functions inherited from FPMixinInterface
 FPMixinInterface (const FPMixinInterface &rhs)
 
FPMixinInterfaceoperator= (const FPMixinInterface &rhs)
 
- Protected Member Functions inherited from FPInterface
virtual FPStatus _dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 
- Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > * interfaceNotifyCBs
 

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
get_mapping 
set_mapping 
get_shadows 
set_shadows 
get_autoReflect 
set_autoReflect 
get_forceWire 
set_forceWire 
get_antialias 
set_antialias 
get_filter 
set_filter 
get_objMotBlur 
set_objMotBlur 
get_velMotBlur 
set_velMotBlur 
get_applyVelBlurEnv 
set_applyVelBlurEnv 
get_velBlurTrans 
set_velBlurTrans 
get_memFrugal 
set_memFrugal 
get_pixelSamplerEnable 
set_pixelSamplerEnable 
get_wireThickness 
set_wireThickness 
get_objBlurDuration 
set_objBlurDuration 
get_velBlurDuration 
set_velBlurDuration 
get_antiAliasFilterSz 
set_antiAliasFilterSz 
get_NBlurSamples 
set_NBlurSamples 
get_NBlurFrames 
set_NBlurFrames 
get_autoReflLevels 
set_autoReflLevels 
get_colorClampType 
set_colorClampType 
get_antiAliasFilter 
set_antiAliasFilter 
get_enableSSE 
set_enableSSE 
get_globalSamplerEnabled 
set_globalSamplerEnabled 
get_globalSamplerClassByName 
set_globalSamplerClassByName 
get_globalSamplerSampleMaps 
set_globalSamplerSampleMaps 
get_globalSamplerQuality 
set_globalSamplerQuality 
get_globalSamplerAdaptive 
set_globalSamplerAdaptive 
get_globalSamplerAdaptiveThresh 
set_globalSamplerAdaptiveThresh 
get_globalSamplerParam1 
set_globalSamplerParam1 
get_globalSamplerParam2 
set_globalSamplerParam2 
204  };
@ get_objMotBlur
Definition: IScanRenderer.h:180
@ get_velMotBlur
Definition: IScanRenderer.h:181
@ get_globalSamplerParam1
Definition: IScanRenderer.h:202
@ set_colorClampType
Definition: IScanRenderer.h:193
@ set_forceWire
Definition: IScanRenderer.h:177
@ set_memFrugal
Definition: IScanRenderer.h:184
@ set_autoReflLevels
Definition: IScanRenderer.h:192
@ get_globalSamplerAdaptiveThresh
Definition: IScanRenderer.h:201
@ set_wireThickness
Definition: IScanRenderer.h:186
@ get_forceWire
Definition: IScanRenderer.h:177
@ get_NBlurSamples
Definition: IScanRenderer.h:190
@ get_autoReflect
Definition: IScanRenderer.h:176
@ set_globalSamplerQuality
Definition: IScanRenderer.h:199
@ get_antiAliasFilter
Definition: IScanRenderer.h:194
@ set_globalSamplerSampleMaps
Definition: IScanRenderer.h:198
@ get_antialias
Definition: IScanRenderer.h:178
@ get_globalSamplerParam2
Definition: IScanRenderer.h:203
@ set_objBlurDuration
Definition: IScanRenderer.h:187
@ get_antiAliasFilterSz
Definition: IScanRenderer.h:189
@ get_applyVelBlurEnv
Definition: IScanRenderer.h:182
@ set_NBlurSamples
Definition: IScanRenderer.h:190
@ get_mapping
Definition: IScanRenderer.h:174
@ get_wireThickness
Definition: IScanRenderer.h:186
@ get_velBlurTrans
Definition: IScanRenderer.h:183
@ set_globalSamplerAdaptive
Definition: IScanRenderer.h:200
@ get_colorClampType
Definition: IScanRenderer.h:193
@ set_globalSamplerEnabled
Definition: IScanRenderer.h:196
@ get_velBlurDuration
Definition: IScanRenderer.h:188
@ set_pixelSamplerEnable
Definition: IScanRenderer.h:185
@ set_globalSamplerParam1
Definition: IScanRenderer.h:202
@ set_antiAliasFilter
Definition: IScanRenderer.h:194
@ get_autoReflLevels
Definition: IScanRenderer.h:192
@ get_globalSamplerQuality
Definition: IScanRenderer.h:199
@ set_globalSamplerParam2
Definition: IScanRenderer.h:203
@ set_NBlurFrames
Definition: IScanRenderer.h:191
@ set_applyVelBlurEnv
Definition: IScanRenderer.h:182
@ get_filter
Definition: IScanRenderer.h:179
@ set_autoReflect
Definition: IScanRenderer.h:176
@ get_NBlurFrames
Definition: IScanRenderer.h:191
@ get_pixelSamplerEnable
Definition: IScanRenderer.h:185
@ set_velBlurDuration
Definition: IScanRenderer.h:188
@ get_objBlurDuration
Definition: IScanRenderer.h:187
@ get_globalSamplerAdaptive
Definition: IScanRenderer.h:200
@ get_memFrugal
Definition: IScanRenderer.h:184
@ set_mapping
Definition: IScanRenderer.h:174
@ get_shadows
Definition: IScanRenderer.h:175
@ set_objMotBlur
Definition: IScanRenderer.h:180
@ set_velMotBlur
Definition: IScanRenderer.h:181
@ get_enableSSE
Definition: IScanRenderer.h:195
@ get_globalSamplerClassByName
Definition: IScanRenderer.h:197
@ set_filter
Definition: IScanRenderer.h:179
@ set_globalSamplerClassByName
Definition: IScanRenderer.h:197
@ get_globalSamplerSampleMaps
Definition: IScanRenderer.h:198
@ set_globalSamplerAdaptiveThresh
Definition: IScanRenderer.h:201
@ set_antiAliasFilterSz
Definition: IScanRenderer.h:189
@ set_velBlurTrans
Definition: IScanRenderer.h:183
@ set_antialias
Definition: IScanRenderer.h:178
@ set_shadows
Definition: IScanRenderer.h:175
@ get_globalSamplerEnabled
Definition: IScanRenderer.h:196
@ set_enableSSE
Definition: IScanRenderer.h:195

Member Function Documentation

◆ PROP_FNS() [1/30]

PROP_FNS ( get_mapping  ,
GetMapping  ,
set_mapping  ,
SetMapping  ,
TYPE_BOOL   
)

◆ PROP_FNS() [2/30]

PROP_FNS ( get_shadows  ,
GetShadows  ,
set_shadows  ,
SetShadows  ,
TYPE_BOOL   
)

◆ PROP_FNS() [3/30]

◆ PROP_FNS() [4/30]

PROP_FNS ( get_forceWire  ,
GetForceWire  ,
set_forceWire  ,
SetForceWire  ,
TYPE_BOOL   
)

◆ PROP_FNS() [5/30]

PROP_FNS ( get_antialias  ,
GetAntialias  ,
set_antialias  ,
SetAntialias  ,
TYPE_BOOL   
)

◆ PROP_FNS() [6/30]

PROP_FNS ( get_filter  ,
GetFilter  ,
set_filter  ,
SetFilter  ,
TYPE_BOOL   
)

◆ PROP_FNS() [7/30]

◆ PROP_FNS() [8/30]

◆ PROP_FNS() [9/30]

◆ PROP_FNS() [10/30]

◆ PROP_FNS() [11/30]

PROP_FNS ( get_memFrugal  ,
GetMemFrugal  ,
set_memFrugal  ,
SetMemFrugal  ,
TYPE_BOOL   
)

◆ PROP_FNS() [12/30]

◆ PROP_FNS() [13/30]

◆ PROP_FNS() [14/30]

◆ PROP_FNS() [15/30]

◆ PROP_FNS() [16/30]

◆ PROP_FNS() [17/30]

◆ PROP_FNS() [18/30]

◆ PROP_FNS() [19/30]

◆ PROP_FNS() [20/30]

◆ PROP_FNS() [21/30]

◆ PROP_FNS() [22/30]

PROP_FNS ( get_enableSSE  ,
IsSSEEnabled  ,
set_enableSSE  ,
SetEnableSSE  ,
TYPE_BOOL   
)

◆ PROP_FNS() [23/30]

◆ PROP_FNS() [24/30]

◆ PROP_FNS() [25/30]

◆ PROP_FNS() [26/30]

◆ PROP_FNS() [27/30]

◆ PROP_FNS() [28/30]

◆ PROP_FNS() [29/30]

◆ PROP_FNS() [30/30]

◆ GetDesc()

FPInterfaceDesc* GetDesc ( )
virtual
Remarks
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

◆ SetAntiAliasFilterRT()

void SetAntiAliasFilterRT ( ReferenceTarget op)
inline
253  {
254  if (op && op->SuperClassID( ) == FILTER_KERNEL_CLASS_ID)
255  SetAntiAliasFilter(static_cast< FilterKernel* >(op));
256  }
Definition: sfx.h:742
virtual void SetAntiAliasFilter(FilterKernel *pKernel)=0
virtual CoreExport SClass_ID SuperClassID()
Retrieves a constant representing the type of the plugin.
#define FILTER_KERNEL_CLASS_ID
Anti-aliasing filter kernel super-class ID.
Definition: plugapi.h:451

◆ GetWireThickness()

virtual float GetWireThickness ( )
pure virtual

◆ SetColorClampType()

virtual void SetColorClampType ( int  i)
pure virtual

◆ GetColorClampType()

virtual int GetColorClampType ( )
pure virtual

◆ GetObjBlurDuration()

virtual float GetObjBlurDuration ( )
pure virtual

◆ GetNBlurSamples()

virtual int GetNBlurSamples ( )
pure virtual

◆ GetNBlurFrames()

virtual int GetNBlurFrames ( )
pure virtual

◆ GetVelBlurDuration()

virtual float GetVelBlurDuration ( )
pure virtual

◆ SetApplyVelBlurEnv()

virtual void SetApplyVelBlurEnv ( BOOL  b)
pure virtual

◆ GetApplyVelBlurEnv()

virtual BOOL GetApplyVelBlurEnv ( )
pure virtual

◆ SetVelBlurTrans()

virtual void SetVelBlurTrans ( BOOL  b)
pure virtual

◆ GetVelBlurTrans()

virtual BOOL GetVelBlurTrans ( )
pure virtual

◆ GetAutoReflLevels()

virtual int GetAutoReflLevels ( )
pure virtual

◆ SetMemFrugal()

virtual void SetMemFrugal ( BOOL  b)
pure virtual

◆ GetMemFrugal()

virtual BOOL GetMemFrugal ( )
pure virtual

◆ SetEnableSSE()

virtual void SetEnableSSE ( BOOL  b)
pure virtual

◆ IsSSEEnabled()

virtual BOOL IsSSEEnabled ( )
pure virtual

◆ GetGlobalSamplerEnabled()

virtual BOOL GetGlobalSamplerEnabled ( )
pure virtual

◆ SetGlobalSamplerEnabled()

virtual void SetGlobalSamplerEnabled ( BOOL  enable)
pure virtual

◆ GetGlobalSamplerClassByName()

virtual MSTR GetGlobalSamplerClassByName ( )
pure virtual

◆ SetGlobalSamplerClassByName()

virtual void SetGlobalSamplerClassByName ( const  MSTR)
pure virtual

◆ GetGlobalSamplerSampleMaps()

virtual BOOL GetGlobalSamplerSampleMaps ( )
pure virtual

◆ SetGlobalSamplerSampleMaps()

virtual void SetGlobalSamplerSampleMaps ( BOOL  enable)
pure virtual

◆ GetGlobalSamplerQuality()

virtual float GetGlobalSamplerQuality ( )
pure virtual

◆ SetGlobalSamplerQuality()

virtual void SetGlobalSamplerQuality ( float  f)
pure virtual

◆ GetGlobalSamplerAdaptive()

virtual BOOL GetGlobalSamplerAdaptive ( )
pure virtual

◆ SetGlobalSamplerAdaptive()

virtual void SetGlobalSamplerAdaptive ( BOOL  enable)
pure virtual

◆ GetGlobalSamplerAdaptiveThresh()

virtual float GetGlobalSamplerAdaptiveThresh ( )
pure virtual

◆ SetGlobalSamplerAdaptiveThresh()

virtual void SetGlobalSamplerAdaptiveThresh ( float  f)
pure virtual

◆ GetGlobalSamplerParam1()

virtual float GetGlobalSamplerParam1 ( )
pure virtual

◆ SetGlobalSamplerParam1()

virtual void SetGlobalSamplerParam1 ( float  f)
pure virtual

◆ GetGlobalSamplerParam2()

virtual float GetGlobalSamplerParam2 ( )
pure virtual

◆ SetGlobalSamplerParam2()

virtual void SetGlobalSamplerParam2 ( float  f)
pure virtual