Interface to the layers functionality. More...

#include <ilayer.h>

Inheritance diagram for ILayer:

Public Member Functions
virtual SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin. More...

Layer Information
virtual void	SetName (const MSTR &name)=0

virtual MSTR	GetName () const =0

virtual void	SetWireColor (DWORD newcol, bool propagate=false)=0

virtual DWORD	GetWireColor () const =0

Interactivity Properties
virtual void	Hide (bool onOff, bool propagate=false)=0

virtual bool	IsHidden (bool includeParent=true) const =0

virtual void	Freeze (bool onOff, bool propagate=false)=0

virtual bool	IsFrozen (bool includeParent=true) const =0

Display Properties
virtual void	XRayMtl (bool onOff, bool propagate=false)=0

virtual bool	HasXRayMtl () const =0

virtual void	BoxMode (bool onOff, bool propagate=false)=0

virtual bool	GetBoxMode () const =0

virtual void	BackCull (bool onOff, bool propagate=false)=0

virtual bool	GetBackCull () const =0

virtual void	AllEdges (bool onOff, bool propagate=false)=0

virtual bool	GetAllEdges () const =0

virtual void	VertTicks (bool onOff, bool propagate=false)=0

virtual bool	GetVertTicks () const =0

virtual void	Trajectory (bool onOff, bool propagate=false)=0

virtual bool	GetTrajectory () const =0

virtual void	IgnoreExtents (bool onOff, bool propagate=false)=0

virtual bool	GetIgnoreExtents () const =0

virtual void	SetShowFrozenWithMtl (bool onOff, bool propagate=false)=0

virtual bool	ShowFrozenWithMtl () const =0

virtual void	SetCVertMode (bool onOff, bool propagate=false)=0

virtual bool	GetCVertMode () const =0

virtual void	SetShadeCVerts (bool onOff)=0

virtual bool	GetShadeCVerts () const =0

Rendering Properties
virtual void	SetVisibility (TimeValue t, float vis)=0

virtual float	GetVisibility (TimeValue t, Interval *valid=NULL) const =0

virtual float	GetVisibility (TimeValue t, View &view, Interval *valid=NULL) const =0

virtual float	GetLocalVisibility (TimeValue t, Interval *valid) const =0

virtual bool	IsHiddenByVisControl ()=0

virtual void	SetRenderable (bool onOff, bool propagate=false)=0

virtual bool	Renderable () const =0

virtual void	SetInheritVisibility (bool onOff)=0

virtual bool	GetInheritVisibility () const =0

virtual void	SetPrimaryVisibility (bool onOff)=0

virtual bool	GetPrimaryVisibility () const =0

virtual void	SetSecondaryVisibility (bool onOff)=0

virtual bool	GetSecondaryVisibility () const =0

virtual void	SetCastShadows (bool onOff)=0

virtual bool	CastShadows () const =0

virtual void	SetRcvShadows (bool onOff)=0

virtual bool	RcvShadows () const =0

virtual void	SetApplyAtmospherics (bool onOff)=0

virtual bool	ApplyAtmospherics () const =0

virtual void	SetRenderOccluded (bool onOff)=0

virtual int	GetRenderOccluded () const =0

Motion Blur Properties
virtual bool	GetMotBlurOnOff (TimeValue t) const =0

virtual void	SetMotBlurOnOff (TimeValue t, bool onOff)=0

virtual float	GetImageBlurMultiplier (TimeValue t) const =0

virtual void	SetImageBlurMultiplier (TimeValue t, float m)=0

virtual void	SetMotBlur (int kind)=0

virtual int	MotBlur () const =0

By Layer Methods
virtual void	SetDisplayByLayer (BOOL onOff, INode *node)=0

virtual void	SetRenderByLayer (BOOL onOff, INode *node)=0

virtual void	SetMotionByLayer (BOOL onOff, INode *node)=0

virtual BOOL	GetDisplayByLayer (INode *node) const =0

virtual BOOL	GetRenderByLayer (INode *node) const =0

virtual BOOL	GetMotionByLayer (INode *node) const =0

INode methods
virtual bool	AddToLayer (INode *node)=0

virtual bool	DeleteFromLayer (INode *rtarg)=0

virtual bool	Used (void) const =0

virtual bool	HasObjects () const =0

virtual void	SelectObjects (void)=0

Hierarchy methods
virtual ILayer *	GetParentLayer () const =0

virtual bool	SetParentLayer (ILayer *parentLayer)=0

virtual ILayer *	GetChildLayer (int n) const =0

virtual int	GetNumOfChildLayers () const =0

Internal Flags and Unused Properties

virtual int	GetRenderFlags () const =0

virtual void	SetRenderFlags (int flags)=0

virtual int	GetDisplayFlags () const =0

virtual bool	GetFlag (int mask) const =0

virtual bool	GetFlag2 (int mask) const =0

virtual void	UpdateSelectionSet (void)=0

virtual int	GetRenderFlags (int oldlimits) const =0

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

Static Public Attributes
static const SClass_ID	kLayerSuperClassID
	The super class ID of the layer interface class. More...

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

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

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 Attributes inherited from Animatable
DWORD	aflag

AnimPropertyList	aprops

Detailed Description

Interface to the layers functionality.

Description:: Layers govern (override) some properties of the nodes which are on the layer. For example, a Layer could be used to freeze all the nodes on it without having to set this property of each node individually.

Some of the methods below are not functional in 3ds Max. Such cases are noted in the remarks for the method.

See also: Class ReferenceTarget, Class ILayerManager, Class INode.

Member Function Documentation

◆ SuperClassID()

virtual SClass_ID SuperClassID ( )

inlinevirtual

Retrieves a constant representing the type of the plugin.

Returns: A super class id that uniquely identifies the type (category) of the plugin. Note that several plugin classes can be of the same type, thus return the same super class id. Plugins are uniquely identified by their class ids.

See also: SClass_ID

Reimplemented from ReferenceTarget.

40 { return kLayerSuperClassID; }

ILayer::kLayerSuperClassID

static const SClass_ID kLayerSuperClassID

The super class ID of the layer interface class.

Definition: ilayer.h:37

◆ SetName()

virtual void SetName ( const MSTR & name )

pure virtual

Remarks: Sets the name of this layer.

Parameters

name	- The name for this layer.

◆ GetName()

virtual MSTR GetName ( ) const

pure virtual

Remarks: Returns the name of this layer.

◆ SetWireColor()

virtual void SetWireColor	(	DWORD	newcol,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the wire frame color.

Parameters

newcol	- See COLORREF.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetWireColor()

virtual DWORD GetWireColor ( ) const

pure virtual

Remarks: Returns the wire frame color. See COLORREF.

◆ Hide()

virtual void Hide	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the hidden state.

Parameters

onOff	- Use true for hidden; false for not hidden.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ IsHidden()

virtual bool IsHidden ( bool includeParent = true ) const

pure virtual

Remarks: Returns true if hidden; false if not hidden.

Parameters

includeParent - Use true to get "by layer" hidden state; false for the object permanent hidden state. A child layer is considered hidden by layer when his parent is hidden (by layer or permanently), regardless of its permanent state, which is preserved when hiding through a parent layer.

◆ Freeze()

virtual void Freeze	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the frozen state.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ IsFrozen()

virtual bool IsFrozen ( bool includeParent = true ) const

pure virtual

Remarks: Returns true if frozen; false if not frozen.

Parameters

includeParent - Use true to get "by layer" frozen state; false for the object permanent frozen state. A child layer is considered frozen by layer when his parent is frozen (by layer or permanently), regardless of its permanent state, which is preserved when freezing through a parent layer.

◆ XRayMtl()

virtual void XRayMtl	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the See-through material property.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ HasXRayMtl()

virtual bool HasXRayMtl ( ) const

pure virtual

Remarks: Returns true if See-through material is set; false if not.

◆ BoxMode()

virtual void BoxMode	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the box mode state.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetBoxMode()

virtual bool GetBoxMode ( ) const

pure virtual

Remarks: Returns true if box mode is on; false if off.

◆ BackCull()

virtual void BackCull	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the backface culling state.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetBackCull()

virtual bool GetBackCull ( ) const

pure virtual

Remarks: Returns true if backface culling is on; false if not.

◆ AllEdges()

virtual void AllEdges	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the all edges setting.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetAllEdges()

virtual bool GetAllEdges ( ) const

pure virtual

Remarks: Returns true if all edges is on; false if off.

◆ VertTicks()

virtual void VertTicks	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the vertex ticks state.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetVertTicks()

virtual bool GetVertTicks ( ) const

pure virtual

Remarks: Returns true if vertex ticks is on; false if off.

◆ Trajectory()

virtual void Trajectory	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the Trajectory flag state

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetTrajectory()

virtual bool GetTrajectory ( ) const

pure virtual

Remarks: Returns true if the display trajectory flag for the layer is set.

◆ IgnoreExtents()

virtual void IgnoreExtents	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the ignore extents property.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetIgnoreExtents()

virtual bool GetIgnoreExtents ( ) const

pure virtual

Remarks: Returns true if ignore extents is on; false if off.

◆ SetShowFrozenWithMtl()

virtual void SetShowFrozenWithMtl	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the Show Frozen with Material property.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ ShowFrozenWithMtl()

virtual bool ShowFrozenWithMtl ( ) const

pure virtual

Remarks: Gets whether the objects on the layer are frozen in gray.

◆ SetCVertMode()

virtual void SetCVertMode	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the color per vertex display mode.

Parameters

onOff	- Use true for on; false for off.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ GetCVertMode()

virtual bool GetCVertMode ( ) const

pure virtual

Remarks: Returns true if the color vertex display mode is on; otherwise false.

◆ SetShadeCVerts()

virtual void SetShadeCVerts ( bool onOff )

pure virtual

Remarks: Sets the shaded color vertex display mode.

Parameters

onOff - Use true for on; false for off.

◆ GetShadeCVerts()

virtual bool GetShadeCVerts ( ) const

pure virtual

Remarks: Returns true if the shaded color vertex mode is on; false if off.

◆ SetVisibility()

virtual void SetVisibility	(	TimeValue	t,
		float	vis
	)

pure virtual

Remarks: Sets the visibility at the specified time

Parameters

t	- The time at which to set the value
vis	- The new value for visibility

◆ GetVisibility() [1/2]

virtual float GetVisibility	(	TimeValue	t,
		Interval *	valid = `NULL`
	)		const

pure virtual

Remarks: Gets the visibility at the specified time

Parameters

t	- Unused.
valid	- Unused.

◆ GetVisibility() [2/2]

virtual float GetVisibility	(	TimeValue	t,
		View &	view,
		Interval *	valid = `NULL`
	)		const

pure virtual

Remarks: Gets the visibility at the specified time and viewport. Identical to GetVisibility.

Parameters

t	- Unused.
view	- Unused.
valid	- Unused.

◆ GetLocalVisibility()

virtual float GetLocalVisibility	(	TimeValue	t,
		Interval *	valid
	)		const

pure virtual

Remarks: Identical to GetVisibility. All params unused.

◆ IsHiddenByVisControl()

virtual bool IsHiddenByVisControl ( )

pure virtual

Remarks: Always returns false

◆ SetRenderable()

virtual void SetRenderable	(	bool	onOff,
		bool	propagate = `false`
	)

pure virtual

Remarks: Sets the renderable state.

Parameters

onOff	- Use true for renderable; false for not renderable.
propagate	- Use true to pass the value to child layers, false to set just this one layer

◆ Renderable()

virtual bool Renderable ( ) const

pure virtual

Remarks: Returns true if renderable; false if not.

◆ SetInheritVisibility()

virtual void SetInheritVisibility ( bool onOff )

pure virtual

Remarks: This method allows you to set the inherit visibility flag for the layer.

Parameters

onOff - TRUE to set; FALSE to unset.

◆ GetInheritVisibility()

virtual bool GetInheritVisibility ( ) const

pure virtual

Remarks: This method returns TRUE if the inherit visibility flag for the layer is set.

◆ SetPrimaryVisibility()

virtual void SetPrimaryVisibility ( bool onOff )

pure virtual

Remarks: This method allows you to set or unset the primary visibility flag for the layer. Otherwise known as Visible to Camera.

Parameters

onOff - TRUE to set; FALSE to unset.

◆ GetPrimaryVisibility()

virtual bool GetPrimaryVisibility ( ) const

pure virtual

Remarks: This method returns TRUE if the primary visibility flag for the layer is set. Otherwise known as Visible to Camera.

◆ SetSecondaryVisibility()

virtual void SetSecondaryVisibility ( bool onOff )

pure virtual

Remarks: This method allows you to set the secondary visibility flag for the layer. Otherwise known as Visible to Reflection and Refraction.

Parameters

onOff - TRUE to set; FALSE to unset.

◆ GetSecondaryVisibility()

virtual bool GetSecondaryVisibility ( ) const

pure virtual

Remarks: This method returns TRUE if the secondary visibility flag for the layer is set. Otherwise known as Visible to Reflection and Refraction.

◆ SetCastShadows()

virtual void SetCastShadows ( bool onOff )

pure virtual

Remarks: Sets the cast shadow state.

Parameters

onOff - Use true for on; false for off.

◆ CastShadows()

virtual bool CastShadows ( ) const

pure virtual

Remarks: Returns true if cast shadow is on; false if off.

◆ SetRcvShadows()

virtual void SetRcvShadows ( bool onOff )

pure virtual

Remarks: Sets the receives shadow state.

Parameters

onOff - Use true for on; false for off.

◆ RcvShadows()

virtual bool RcvShadows ( ) const

pure virtual

Remarks: Returns true if receives shadow is on; false if off.

◆ SetApplyAtmospherics()

virtual void SetApplyAtmospherics ( bool onOff )

pure virtual

Remarks: When on, atmospheric effects are applied to the layer. When off atmospheric effects do not change the rendered appearance of this layer.

Parameters

onOff - Use true for on; false for off.

◆ ApplyAtmospherics()

virtual bool ApplyAtmospherics ( ) const

pure virtual

Remarks: Returns true if Atmospherics apply to this layer, false if not.

◆ SetRenderOccluded()

virtual void SetRenderOccluded ( bool onOff )

pure virtual

Remarks: Allows special effects to affect objects in the scene that are occluded by this layer.

Parameters

onOff - Use true for on; false for off.

◆ GetRenderOccluded()

virtual int GetRenderOccluded ( ) const

pure virtual

Remarks: Returns true if Render Occluded is on; false if off.

◆ GetMotBlurOnOff()

virtual bool GetMotBlurOnOff ( TimeValue t ) const

pure virtual

Remarks: This method returns the state of the motion blur flag at the specified time.

Parameters

t	- The time at which to get the flag.

◆ SetMotBlurOnOff()

virtual void SetMotBlurOnOff	(	TimeValue	t,
		bool	onOff
	)

pure virtual

Remarks: This method allows you to set the state of the motion blur flag at the specified time.

Parameters

t	- The time at which to set the flag.
onOff	- TRUE to turn on; FALSE to turn off.

◆ GetImageBlurMultiplier()

virtual float GetImageBlurMultiplier ( TimeValue t ) const

pure virtual

Remarks: This method allows you to set the motion blur multiplier for the layer.

Parameters

t	- The timevalue to get the motion blur multiplier for.

◆ SetImageBlurMultiplier()

virtual void SetImageBlurMultiplier	(	TimeValue	t,
		float	m
	)

pure virtual

Remarks: This method allows you to set the image blur multiplier.

Parameters

t	- The timevalue to set the image blur multiplier for.
m	- The multiplier to set.

◆ SetMotBlur()

virtual void SetMotBlur ( int kind )

pure virtual

Remarks: Sets the type of motion blur used by the layer.

Parameters:: int kind

The kind of motion blur. One of the following values:

0: None.

1: Object Motion Blur.

2: Image Motion Blur.

◆ MotBlur()

virtual int MotBlur ( ) const

pure virtual

Remarks: Returns the type of motion blur used by the layer. One of the following values:

0: None.

1: Object Motion Blur.

2: Image Motion Blur.

◆ SetDisplayByLayer()

virtual void SetDisplayByLayer	(	BOOL	onOff,
		INode *	node
	)

pure virtual

Remarks: This method allows you to set the display by layer flag for the specified node.

Parameters

onOff	- TRUE to set; FALSE to unset.
node	- The pointer to the node.

◆ SetRenderByLayer()

virtual void SetRenderByLayer	(	BOOL	onOff,
		INode *	node
	)

pure virtual

Remarks: This method allows you to set the render by layer flag for the specified node.

Parameters

onOff	- TRUE to set; FALSE to unset.
node	- The pointer to the node.

◆ SetMotionByLayer()

virtual void SetMotionByLayer	(	BOOL	onOff,
		INode *	node
	)

pure virtual

Remarks: This method allows you to set the motion by layer flag for the specified node.

Parameters

onOff	- TRUE to set; FALSE to unset.
node	- The pointer to the node.

◆ GetDisplayByLayer()

virtual BOOL GetDisplayByLayer ( INode * node ) const

pure virtual

Remarks: This method returns the state of the display by layer flag for the specified node.

Parameters

node	- The pointer to the node.

Returns: - TRUE if set; FALSE if not set.

◆ GetRenderByLayer()

virtual BOOL GetRenderByLayer ( INode * node ) const

pure virtual

Remarks: This method returns the state of the render by layer flag for the specified node.

Parameters

node	- The pointer to the node.

Returns: - TRUE if set; FALSE if not set.

◆ GetMotionByLayer()

virtual BOOL GetMotionByLayer ( INode * node ) const

pure virtual

Remarks: This method returns the state of the motion by layer flag for the specified node.

Parameters

node	- The pointer to the node.

Returns: TRUE if set; FALSE if not set.

◆ AddToLayer()

virtual bool AddToLayer ( INode * node )

pure virtual

Remarks: Adds the specified node to this layer.

Parameters

node	- The node to add.

◆ DeleteFromLayer()

virtual bool DeleteFromLayer ( INode * rtarg )

pure virtual

Remarks: Deletes the specified node from this layer. Note: This method does nothing in 3ds Max.

Parameters

rtarg - The node to delete from this layer.

◆ Used()

virtual bool Used ( void ) const

pure virtual

Remarks: Returns true if the layer is used (nodes have been added); otherwise false.

◆ HasObjects()

virtual bool HasObjects ( ) const

pure virtual

Remarks: Returns true if the layer is used (nodes have been added); otherwise false.

◆ SelectObjects()

virtual void SelectObjects ( void )

pure virtual

Remarks: This method will select the objects of the layer.

◆ GetParentLayer()

virtual ILayer* GetParentLayer ( ) const

pure virtual

Remarks: Returns the parent Layer. This could be NULL meaning the layer is at the top level.

◆ SetParentLayer()

virtual bool SetParentLayer ( ILayer * parentLayer )

pure virtual

Remarks: Sets the parent layer for this layer.

Parameters

parentLayer - The layer that will become the parent layer.

Returns: Returns TRUE if set; FALSE if not set. There are some cases where you cannot set, for example, you cannot set yourself as your parent. Another example is you cannot set one of your childs as your parent (no cycles).

◆ GetChildLayer()

virtual ILayer* GetChildLayer ( int n ) const

pure virtual

Remarks: Returns a pointer to the Nth child Layer for this layer.

Parameters

n	- The index of the child layer.

Returns: Returns a pointer to the Nth child layer.

◆ GetNumOfChildLayers()

virtual int GetNumOfChildLayers ( ) const

pure virtual

Remarks: Returns the number of child layers in this layer.

Returns: The number of child layers in this layer.

◆ GetRenderFlags() [1/2]

virtual int GetRenderFlags ( ) const

pure virtual

◆ SetRenderFlags()

virtual void SetRenderFlags ( int flags )

pure virtual

◆ GetDisplayFlags()

virtual int GetDisplayFlags ( ) const

pure virtual

◆ GetFlag()

virtual bool GetFlag ( int mask ) const

pure virtual

◆ GetFlag2()

virtual bool GetFlag2 ( int mask ) const

pure virtual

◆ UpdateSelectionSet()

virtual void UpdateSelectionSet ( void )

pure virtual

Remarks: This method is for internal use in VIZ. Note: This method does nothing in 3ds Max.

◆ GetRenderFlags() [2/2]

virtual int GetRenderFlags ( int oldlimits ) const

pure virtual

Remarks: This method returns the render flags associated with the layer.

Parameters

oldlimits - The old limits flag.

Member Data Documentation

◆ kLayerSuperClassID

const SClass_ID kLayerSuperClassID

static

The super class ID of the layer interface class.

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ SuperClassID()

◆ SetName()

◆ GetName()

◆ SetWireColor()

◆ GetWireColor()

◆ Hide()

◆ IsHidden()

◆ Freeze()

◆ IsFrozen()

◆ XRayMtl()

◆ HasXRayMtl()

◆ BoxMode()

◆ GetBoxMode()

◆ BackCull()

◆ GetBackCull()

◆ AllEdges()

◆ GetAllEdges()

◆ VertTicks()

◆ GetVertTicks()

◆ Trajectory()

◆ GetTrajectory()

◆ IgnoreExtents()

◆ GetIgnoreExtents()

◆ SetShowFrozenWithMtl()

◆ ShowFrozenWithMtl()

◆ SetCVertMode()

◆ GetCVertMode()

◆ SetShadeCVerts()

◆ GetShadeCVerts()

◆ SetVisibility()

◆ GetVisibility() [1/2]

◆ GetVisibility() [2/2]

◆ GetLocalVisibility()

◆ IsHiddenByVisControl()

◆ SetRenderable()

◆ Renderable()

◆ SetInheritVisibility()

◆ GetInheritVisibility()

◆ SetPrimaryVisibility()

◆ GetPrimaryVisibility()

◆ SetSecondaryVisibility()

◆ GetSecondaryVisibility()

◆ SetCastShadows()

◆ CastShadows()

◆ SetRcvShadows()

◆ RcvShadows()

◆ SetApplyAtmospherics()

◆ ApplyAtmospherics()

◆ SetRenderOccluded()

◆ GetRenderOccluded()

◆ GetMotBlurOnOff()

◆ SetMotBlurOnOff()

◆ GetImageBlurMultiplier()

◆ SetImageBlurMultiplier()

◆ SetMotBlur()

◆ MotBlur()

◆ SetDisplayByLayer()

◆ SetRenderByLayer()

◆ SetMotionByLayer()

◆ GetDisplayByLayer()

◆ GetRenderByLayer()

◆ GetMotionByLayer()

◆ AddToLayer()

◆ DeleteFromLayer()

◆ Used()

◆ HasObjects()

◆ SelectObjects()

◆ GetParentLayer()

◆ SetParentLayer()

◆ GetChildLayer()

◆ GetNumOfChildLayers()

◆ GetRenderFlags() [1/2]

◆ SetRenderFlags()

◆ GetDisplayFlags()

◆ GetFlag()