LightObject Class Reference

This is the base class from which plug-in lights may be derived. More...

#include <object.h>

Inheritance diagram for LightObject:

Public Member Functions
SClass_ID	SuperClassID ()
	Retrieves a constant representing the type of the plugin. More...
int	IsRenderable ()
	Indicates whether the object may be rendered. More...
virtual void	InitNodeName (MSTR &s) override
	This is the default name of the node when it is created. More...
virtual CoreExport void *	GetInterface (ULONG id) override
	Inherited from Animatable. More...
virtual CoreExport BaseInterface *	GetInterface (Interface_ID id) override
	Inherited from Animatable. More...
virtual RefResult	EvalLightState (TimeValue time, Interval &valid, LightState *ls)=0
	This method is called to update the passed LightState and validity interval of the light. More...
RefResult	EvalLightState (TimeValue time, LightState *ls)
virtual ObjLightDesc *	CreateLightDesc (INode *n, BOOL forceShadowBuffer=FALSE)
	When the renderer goes to render the scene it asks all of the lights to create an ObjectLighDesc object. More...
virtual ObjLightDesc *	CreateLightDesc (RenderGlobalContext *rgc, INode *inode, BOOL forceShadowBuf=FALSE)
virtual void	SetUseLight (int onOff)=0
	Sets if the light is on or off. More...
virtual BOOL	GetUseLight (void)=0
	Returns TRUE if the light is on; otherwise FALSE. More...
virtual void	SetHotspot (TimeValue time, float f)=0
	Sets the hotspot to the specified angle at the specified time. More...
virtual float	GetHotspot (TimeValue t, Interval &valid)=0
	Retrieves the hotspot angle. More...
float	GetHotspot (TimeValue t)
	Retrieves the hotspot angle. More...
virtual void	SetFallsize (TimeValue time, float f)=0
	Sets the falloff setting of the light. More...
virtual float	GetFallsize (TimeValue t, Interval &valid)=0
	Returns the falloff angle of the light in degrees. More...
float	GetFallsize (TimeValue t)
	Returns the falloff angle of the light in degrees. More...
virtual void	SetAtten (TimeValue time, int which, float f)=0
	Sets the specified attenuation range distance at the time passed. More...
virtual float	GetAtten (TimeValue t, int which, Interval &valid)=0
	Returns the specified attenuation range distance at the time passed. More...
float	GetAtten (TimeValue t, int which)
	Returns the specified attenuation range distance at the time passed. More...
virtual void	SetTDist (TimeValue time, float f)=0
	Sets the light's target distance. More...
virtual float	GetTDist (TimeValue t, Interval &valid)=0
	Retrieves the light's target distance. More...
float	GetTDist (TimeValue t)
	Retrieves the light's target distance. More...
virtual void	SetConeDisplay (int s, int notify=TRUE)=0
	Sets the light's cone display flag. More...
virtual BOOL	GetConeDisplay (void)=0
	Retrieves the light's cone display setting. More...
virtual int	GetShadowMethod ()
	Returns the type of shadows used by the light. More...
virtual void	SetRGBColor (TimeValue t, const Point3 &rgb)
	Sets the color of the light at the specified time. More...
virtual Point3	GetRGBColor (TimeValue t, Interval &valid)
	Returns the color of the light at the specified time and updates the validity interval to reflect this parameters validity interval. More...
Point3	GetRGBColor (TimeValue t)
	Returns the color of the light at the specified time. More...
virtual void	SetIntensity (TimeValue time, float f)
	Sets the intensity of the light to the value passed. More...
virtual float	GetIntensity (TimeValue t, Interval &valid)
	Retrieves the intensity of the light at the specified time and updates the validity interval passed to reflect the validity interval of this parameter. More...
float	GetIntensity (TimeValue t)
	Retrieves the intensity of the light at the specified time. More...
virtual void	SetAspect (TimeValue t, float f)
	Sets the aspect ratio of the light at the specified time. More...
virtual float	GetAspect (TimeValue t, Interval &valid)
	Retrieves the aspect ratio of the light at the specified time and updates the validity interval passed to reflect the validity interval of this parameter. More...
float	GetAspect (TimeValue t)
	Retrieves the aspect ratio of the light at the specified time. More...
virtual void	SetUseAtten (int s)
	Sets the flag to indicate if the light is attenuated. More...
virtual BOOL	GetUseAtten (void)
	Returns TRUE to indicate the light is attenuated; otherwise FALSE. More...
virtual void	SetAttenDisplay (int s)
	Sets the flag to indicate if the light attenuation ranges are displayed. More...
virtual BOOL	GetAttenDisplay (void)
	Returns TRUE if the light attenuation ranges are displayed; otherwise FALSE. More...
virtual void	Enable (int enab)
	Sets the light to enabled or disables (on or off). More...
virtual void	SetMapBias (TimeValue t, float f)
	Sets the map bias setting at the time passed. More...
virtual float	GetMapBias (TimeValue t, Interval &valid)
	Returns the map bias setting at the time passed and updates the validity interval to reflect the validity interval of this parameter. More...
float	GetMapBias (TimeValue t)
	Returns the map bias setting at the time passed. More...
virtual void	SetMapRange (TimeValue t, float f)
	Sets the map sample range setting to the value passed at the time passed. More...
virtual float	GetMapRange (TimeValue t, Interval &valid)
	Retrieves the lights map sample range setting at the specified time and updates the validity interval to reflect the validity interval of this parameter. More...
float	GetMapRange (TimeValue t)
	Retrieves the lights map sample range setting at the specified time. More...
virtual void	SetMapSize (TimeValue t, int f)
	Sets the lights map size parameter to the value passed at the time passed. More...
virtual int	GetMapSize (TimeValue t, Interval &valid)
	Returns the lights map size parameter at the specified time and updates the validity interval passed to reflect the validity interval of this parameter. More...
int	GetMapSize (TimeValue t)
	Returns the lights map size parameter at the specified time. More...
virtual void	SetRayBias (TimeValue t, float f)
	Sets the raytrace bias setting to the value passed at the specified time. More...
virtual float	GetRayBias (TimeValue t, Interval &valid)
	Returns the lights raytrace bias setting at the specified time and updates the validity interval passed to reflect the validity interval of this parameter. More...
float	GetRayBias (TimeValue t)
	Returns the lights raytrace bias setting at the specified time. More...
virtual int	GetUseGlobal ()
	Returns the Use Global Settings flag setting. More...
virtual void	SetUseGlobal (int a)
	Sets the lights Use Global Settings flag. More...
virtual int	GetShadow ()
	Returns the lights Cast Shadows flag. More...
virtual void	SetShadow (int a)
	Sets the lights Cast Shadows flag. More...
virtual int	GetShadowType ()
	Retrieves the type of shadows used by the light - mapped or raytraced. More...
virtual void	SetShadowType (int a)
	Sets the type of shadows used by the light - mapped or raytraced. More...
virtual int	GetAbsMapBias ()
	Returns the lights Absolute Map Bias setting. More...
virtual void	SetAbsMapBias (int a)
	Sets the lights Absolute Map Bias setting. More...
virtual int	GetOvershoot ()
	Returns the lights Overshoot on / off setting. More...
virtual void	SetOvershoot (int a)
	Sets the lights Overshoot on / off setting. More...
virtual int	GetProjector ()
	Returns the lights Projector on / off setting. More...
virtual void	SetProjector (int a)
	Sets the lights projector on / off setting. More...
virtual ExclList *	GetExclList ()
	Returns the list of names of items included or excluded by this light. More...
virtual BOOL	Include ()
	Returns TRUE if the light's name list is of items to be included by the light. More...
virtual Texmap *	GetProjMap ()
	Returns the map used by a projector light. More...
virtual void	SetProjMap (Texmap *pmap)
	Sets the image(s) used by the projector light. More...
virtual void	UpdateTargDistance (TimeValue t, INode *inode)
	Updates the display of the light's target distance in the light's rollup page. More...
Public Member Functions inherited from Object
CoreExport	Object ()
CoreExport	~Object ()
virtual BOOL	CheckObjectIntegrity ()
	This method is used for debugging only. More...
virtual BOOL	HasUVW () override
	Call this method to find out if the object has UVW coordinates. More...
virtual BOOL	HasUVW (int mapChannel) override
	Call this method to find out if the object is has UVW coordinates for the specified mapping channel. More...
virtual Object *	FindBaseObject ()
	It is called to return a pointer to the base object (an object that is not a derived object). More...
virtual BOOL	IsParamSurface ()
	There are several methods used to access a parametric position on the surface of the object. More...
virtual int	NumSurfaces (TimeValue t)
	Returns the number of parametric surfaces within the object. More...
virtual Point3	GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
	This method needs to be implemented if Object::IsParamSurface() returns TRUE. More...
virtual Point3	GetSurfacePoint (TimeValue t, int surface, float u, float v, Interval &iv)
	This method is used to retrieve a point on the specified surface of the object based on two parameters of the surface, u and v. More...
virtual void	SurfaceClosed (TimeValue t, int surface, BOOL &uClosed, BOOL &vClosed)
	This method allows the object to return flags that indicate whether the parametric surface is closed in the U and V dimensions. More...
virtual BOOL	GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
	This method allows an object to return extended Properties fields. More...
CoreExport SvGraphNodeReference	SvTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
CoreExport bool	SvHandleDoubleClick (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport MSTR	SvGetName (IGraphObjectManager *gom, IGraphNode *gNode, bool isBeingEdited)
CoreExport COLORREF	SvHighlightColor (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvIsSelected (IGraphObjectManager *gom, IGraphNode *gNode)
	Returns true if the object is selected in its schematic view. More...
CoreExport MultiSelectCallback *	SvGetMultiSelectCallback (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport bool	SvCanSelect (IGraphObjectManager *gom, IGraphNode *gNode)
CoreExport void	AddXTCObject (XTCObject *pObj, int priority=0, int branchID=-1)
	This method adds an extension object into the pipeline. More...
CoreExport int	NumXTCObjects ()
	Returns the number of extension objects maintained by this Object. More...
CoreExport XTCObject *	GetXTCObject (int index)
	Returns a pointer to the specified extension object. More...
CoreExport void	RemoveXTCObject (int index)
	Removes the extension object as indicated by the index. More...
CoreExport void	SetXTCObjectPriority (int index, int priority)
	Sets the priority for the extension object whose index is passed. More...
CoreExport int	GetXTCObjectPriority (int index)
	Returns the integer priority number of the extension object whose index is passed. More...
CoreExport void	SetXTCObjectBranchID (int index, int branchID)
	Sets the branch ID of the extension object whose index is passed. More...
CoreExport int	GetXTCObjectBranchID (int index)
	Returns the integer branch ID of the extension object whose index is passed. More...
CoreExport void	MergeAdditionalChannels (Object *from, int branchID)
	This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it). More...
CoreExport void	BranchDeleted (int branchID, bool reorderChannels)
	This method has to be called on the CompoundObject so it can delete the XTCObjects for the specified branch. More...
CoreExport void	CopyAdditionalChannels (Object *from, bool deleteOld=true, bool bShallowCopy=false)
	This method copies all extension objects from the "from" object into the current object. More...
CoreExport void	DeleteAllAdditionalChannels ()
	Implemented by the System. More...
virtual BOOL	UseSelectionBrackets ()
	This method allows an object to choose whether or not it will display selection brackets in shaded viewports. More...
virtual BOOL	IsManipulator ()
virtual void	ReduceDisplayCaches ()
	Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it. More...
virtual bool	NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
	This returns whether the Graphics Cache for this object needs to be rebuilt. More...
virtual void	BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
	This builds the graphics window cached mesh. More...
virtual void	StartStackEval ()
	This are called right before and after a modifier is applied to an object. More...
virtual void	EndStackEval ()
virtual int	UsesWireColor ()
	This method determines if the object color is used for display. More...
virtual int	DoOwnSelectHilite ()
	If an object wants to draw itself in the 3D viewports in its selected state in some custom manner this method should return nonzero. More...
virtual int	IntersectRay (TimeValue t, Ray &r, float &at, Point3 &norm)
	This method is called to compute the intersection point and surface normal at this intersection point of the ray passed and the object. More...
virtual BOOL	NormalAlignVector (TimeValue t, Point3 &pt, Point3 &norm)
	Objects that don't support the IntersectRay() method (such as helper objects) can implement this method to provide a default vector for use with the normal align command in 3ds Max. More...
void	LockObject ()
	Implemented by the System. More...
void	UnlockObject ()
	Implemented by the System. More...
int	IsObjectLocked ()
	Implemented by the System. More...
virtual ObjectState	Eval (TimeValue t)=0
	This method is called to evaluate the object and return the result as an ObjectState. More...
void	LockChannels (ChannelMask channels)
	Implemented by the System. More...
void	UnlockChannels (ChannelMask channels)
	Implemented by the System. More...
ChannelMask	GetChannelLocks ()
	Implemented by the System. More...
void	SetChannelLocks (ChannelMask channels)
	Implemented by the System. More...
ChannelMask	GetChannelLocks (ChannelMask m)
	Implemented by the System. More...
virtual BOOL	CanCacheObject ()
	This method determines if this object can have channels cached. More...
virtual void	WSStateInvalidate ()
	This is called by a node when the node's world space state has become invalid. More...
virtual BOOL	IsWorldSpaceObject ()
	Returns TRUE if the object as a world space object; otherwise FALSE. More...
CoreExport INode *	GetWorldSpaceObjectNode ()
	Implemented by the System. More...
virtual BOOL	IsParticleSystem ()
	Implemented by the System. More...
CoreExport void	CopyChannelLocks (Object *obj, ChannelMask needChannels)
	Implemented by the System. More...
virtual void	TopologyChanged ()
	Implemented by the System. More...
virtual int	IsDeformable ()
	Indicates whether this object is deformable. More...
virtual int	NumPoints ()
	The points of a deformable object are accessed through a virtual array interface. More...
virtual Point3	GetPoint (int i)
	The points of a deformable object are accessed through a virtual array interface. More...
virtual void	SetPoint (int i, const Point3 &p)
	The points of a deformable object are accessed through a virtual array interface. More...
virtual BOOL	IsPointSelected (int i)
	Returns TRUE if the 'i-th' point is selected; otherwise FALSE. More...
virtual float	PointSelection (int i)
	Returns a floating point weighted point selection if the object supports it. More...
virtual BOOL	HasWeights ()
	Returns TRUE if the object has weights for its points that can be set; otherwise FALSE. More...
virtual double	GetWeight (int i)
	Returns the weight of the specified point of the object. More...
virtual void	SetWeight (int i, const double w)
	Sets the weight of the specified point. More...
virtual BOOL	PolygonCount (TimeValue t, int &numFaces, int &numVerts)
	Retreives the number of faces and vertices of the polyginal mesh representation of this object. More...
virtual void	PointsWereChanged ()
	Informs the object that its points have been deformed, so it can invalidate its cache. More...
virtual CoreExport void	Deform (Deformer *defProc, int useSel=0)
	This is the method used to deform the object with a deformer. More...
virtual CoreExport void	GetDeformBBox (TimeValue t, Box3 &box, Matrix3 *tm=NULL, BOOL useSel=FALSE)
	This method computes the bounding box in the objects local coordinates or the optional space defined by tm. More...
virtual int	IsMappable ()
	This method lets you know if the ApplyUVWMap() method is available for this object. More...
virtual int	NumMapChannels ()
	Returns the maximum number of channels supported by this type of object. More...
virtual int	NumMapsUsed ()
	Returns the number of maps currently used by this object. More...
virtual void	ApplyUVWMap (int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, int cap, const Matrix3 &tm, int channel=1)
	This method may be called to map the object with UVW mapping coordinates. More...
virtual CoreExport int	CanConvertToType (Class_ID obtype)
	Indicates whether the object can be converted to the specified type. More...
virtual CoreExport Object *	ConvertToType (TimeValue t, Class_ID obtype)
	This method converts this object to the type specified and returns a pointer it. More...
virtual Class_ID	PreferredCollapseType ()
	This method allows objects to specify the class that is the best class to convert to when the user collapses the stack. More...
virtual CoreExport void	GetCollapseTypes (Tab< Class_ID > &clist, Tab< MSTR * > &nlist)
	When the user clicks on the Edit Stack button in the modify branch a list of 'Convert To:' types is presented. More...
virtual Object *	CollapseObject ()
	This method is called on the world space cache object when the stack gets collapsed, that lets the pipeline object decide, if it wants to return a different object than itself. More...
virtual DWORD	GetSubselState ()
	For objects that have sub selection levels, this method returns the current selection level of the object. More...
virtual void	SetSubSelState (DWORD s)
	Implemented by the System. More...
CoreExport void	ReadyChannelsForMod (ChannelMask channels)
	Implemented by the System. More...
virtual CoreExport Interval	ChannelValidity (TimeValue t, int nchan)
	Retrieve the current validity interval for the nchan channel of the object. More...
virtual CoreExport void	SetChannelValidity (int nchan, Interval v)
	Sets the validity interval of the specified channel. More...
virtual CoreExport void	InvalidateChannels (ChannelMask channels)
	This method invalidates the intervals for the given channel mask. More...
virtual CoreExport Interval	ObjectValidity (TimeValue t)
	This method returns the validity interval of the object as a whole at the specified time. More...
virtual Object *	MakeShallowCopy (ChannelMask channels)
	This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels. More...
virtual CoreExport void	ShallowCopy (Object *fromOb, ChannelMask channels)
	This method copies the specified channels from the fromOb to this and copies the validity intervals. More...
virtual CoreExport void	FreeChannels (ChannelMask channels)
	This method deletes the memory associated with the specified channels and set the intervals associated with the channels to invalid (empty). More...
virtual CoreExport void	NewAndCopyChannels (ChannelMask channels)
	This method replaces the locked channels with newly allocated copies. More...
virtual CoreExport void	MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
	This method allows the object to enlarge its viewport rectangle, if it wants to. More...
CoreExport bool	IsBaseClassOwnedChannel (int nchan)
	Implemented by the System. More...
CoreExport void	UpdateValidity (int nchan, Interval v)
	When a modifier is applied to an object, it needs to include its own validity interval in the interval of the object. More...
Interval	GetNoEvalInterval ()
void	SetNoEvalInterval (Interval iv)
virtual CoreExport void	ReduceCaches (TimeValue t)
	This method give the object the chance to reduce its caches. More...
virtual int	IsConstObject ()
	This is called to determine if this is a construction object or not. More...
virtual int	NumPipeBranches (bool selected=true)
	This method returns the number of pipeline branches combined by the object. More...
virtual Object *	GetPipeBranch (int i, bool selected=true)
	Retrieves sub-object branches from an object that supports branching. More...
virtual INode *	GetBranchINode (TimeValue t, INode *node, int i, bool selected=true)
	When an object has sub-object branches, it is likely that the sub-objects are transformed relative to the object. More...
virtual int	NumberOfContainedShapes ()
	Returns the number of shapes contained inside this object. More...
virtual ShapeObject *	GetContainedShape (TimeValue t, int index)
	This method returns the ShapeObject specified by the index passed at the time specified. More...
virtual void	GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
	Returns the matrix associated with the shape whose index is passed. More...
virtual BitArray	ContainedShapeSelectionArray ()
	This is used by the lofter. More...
virtual BOOL	IsShapeObject ()
	Returns the number of shapes contained inside this object. More...
Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long	GetObjectDisplayRequirement () const
virtual CoreExport bool	PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
virtual CoreExport bool	UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport bool	UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArray &	GetRenderItems () const
CoreExport	BaseObject ()
virtual CoreExport	~BaseObject ()
virtual BOOL	HasViewDependentBoundingBox ()
	This method return true if GetWorldBoundBox returns different boxes for different viewports. More...
virtual int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt)
	This method is called to determine if the specified screen point intersects the item. More...
virtual void	SetExtendedDisplay (int flags)
	This method is used for storing mode-dependent display attributes. More...
virtual int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags)
	This is called by the system to have the item display itself (perform a quick render in viewport, using the current TM). More...
virtual void	Snap (TimeValue t, INode *inode, SnapInfo *snap, IPoint2 *p, ViewExp *vpt)
	Checks the point passed for a snap and updates the SnapInfo structure. More...
virtual void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
	This method returns the world space bounding box for Objects (see below for the Sub-object gizmo or Modifiers gizmo version). More...
virtual void	GetLocalBoundBox (TimeValue t, INode *inode, ViewExp *vp, Box3 &box)
	This is the object space bounding box, the box in the object's local coordinates. More...
virtual CreateMouseCallBack *	GetCreateMouseCallBack ()=0
	This method allows the system to retrieve a callback object used in creating an object in the 3D viewports. More...
virtual const MCHAR *	GetObjectName () MAX_SEALED
virtual const MCHAR *	GetObjectName (bool localized) const
virtual CoreExport BOOL	OKToChangeTopology (MSTR &modName)
	Implemented by the System. More...
virtual BOOL	ChangeTopology ()
	This method asks the question of an object or modifier "Do you change topology"? An object or modifier returns TRUE if it is capable of changing topology when its parameters are being edited; otherwise FALSE. More...
virtual void	ForceNotify (Interval &i)
	Notifies dependents of a change. More...
virtual IParamArray *	GetParamBlock ()
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it. More...
virtual IParamBlock2 *	GetParamBlock (int i) override
	An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it. More...
virtual int	GetParamBlockIndex (int id)
	If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block. More...
virtual void	Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by moving its selected sub-object components. More...
virtual void	Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by rotating its selected sub-object components. More...
virtual void	Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
	When this method is called the plug-in should respond by scaling its selected sub-object components. More...
virtual void	TransformStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect. More...
virtual void	TransformHoldingStart (TimeValue t)
	This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect. More...
virtual void	TransformHoldingFinish (TimeValue t)
	This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted. More...
virtual void	TransformFinish (TimeValue t)
	This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted. More...
virtual void	TransformCancel (TimeValue t)
	This method is called when the transform operation is canceled by a right-click and the undo has been canceled. More...
virtual int	HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
	This method is used in modifier gizmo hit testing. More...
virtual int	Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
	When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM. More...
virtual void	GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
	This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo). More...
virtual void	CloneSelSubComponents (TimeValue t)
	This method is called to make a copy of the selected sub-object components of the item. More...
virtual void	AcceptCloneSelSubComponents (TimeValue t)
	This method is called when the user mouses up after shift-cloning a sub-object selection. More...
virtual void	SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
	This method is called to change the selection state of the component identified by hitRec. More...
virtual void	ClearSelection (int selLevel)
	This method is called to clear the selection for the given sub-object level. More...
virtual void	SelectAll (int selLevel)
	This method is called to select every element of the given sub-object level. More...
virtual void	InvertSelection (int selLevel)
	This method is called to invert the specified sub-object level. More...
virtual int	SubObjectIndex (HitRecord *hitRec)
	Returns the index of the sub-object element identified by the HitRecord hitRec. More...
virtual void	ActivateSubobjSel (int level, XFormModes &modes)
	When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in. More...
virtual BOOL	SupportsNamedSubSels ()
	An object that supports sub-object selection can choose to support named sub object selection sets. More...
virtual void	ActivateSubSelSet (MSTR &setName)
	When the user chooses a name from the drop down list this method is called. More...
virtual void	NewSetFromCurSel (MSTR &setName)
	If the user types a new name into the named selection set drop down then this method is called. More...
virtual void	RemoveSubSelSet (MSTR &setName)
	If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called. More...
virtual void	SetupNamedSelDropDown ()
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...
virtual int	NumNamedSelSets ()
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...
virtual MSTR	GetNamedSelSetName (int i)
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...
virtual void	SetNamedSelSetName (int i, MSTR &newName)
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...
virtual void	NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
	To support the Edit Named Selections dialog, plug-ins must implement this method. More...
virtual void	GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
virtual void	GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
	When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis. More...
virtual void	NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
	This method is called before a modifier or object is collapsed. More...
virtual void	NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
	This method is called after a modifier or object is collapsed. More...
virtual int	NumSubObjTypes ()
	Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType(). More...
virtual ISubObjType *	GetSubObjType (int i)
	Returns a pointer to the sub-object type for the sub-object whose index is passed. More...
virtual CoreExport int	GetSubObjectLevel ()
	This method returns an integer which indicates the current sub-object level of the modifier or base object. More...
virtual void	SetGenUVW (BOOL sw)
	This method is called to change the state of its Generate UVW boolean. More...
virtual void	SetGenUVW (int mapChannel, BOOL sw)
	This method is called to change the state of its Generate UVW boolean for the specified mapping channel. More...
virtual void	ShowEndResultChanged (BOOL showEndResult)
	This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled). 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...
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 *	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 ()
CoreExport SvGraphNodeReference	SvStdTraverseAnimGraph (IGraphObjectManager *gom, Animatable *owner, int id, DWORD flags)
virtual CoreExport bool	SvCanInitiateLink (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvCanConcludeLink (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeChild)
virtual CoreExport bool	SvCanSetName (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvSetName (IGraphObjectManager *gom, IGraphNode *gNode, const MSTR &name)
virtual CoreExport bool	SvCanRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvRemoveThis (IGraphObjectManager *gom, IGraphNode *gNode)
	Called when the user deletes this object in the schematic view... More...
virtual CoreExport bool	SvIsHighlighted (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport COLORREF	SvGetSwatchColor (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvIsInactive (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvLinkChild (IGraphObjectManager *gom, IGraphNode *gNodeThis, IGraphNode *gNodeChild)
virtual CoreExport bool	SvEditProperties (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetTip (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRefTip (IGraphObjectManager *gom, IGraphNode *gNode, IGraphNode *gNodeMaker)
virtual CoreExport bool	SvCanDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport bool	SvDetach (IGraphObjectManager *gom, IGraphNode *gNode)
virtual CoreExport MSTR	SvGetRelTip (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
	Returns a string to be displayed in the tip window in the schematic view for a relationship from "gNodeMaker" to "gNodeTarget"... 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 ()

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...
Static Public Attributes inherited from Animatable
static const AnimHandle	kInvalidAnimHandle = 0
Protected Member Functions inherited from ReferenceTarget
virtual CoreExport int	DoEnumDependentsImpl (DependentEnumProc *dep)
	Method to perform an enumeration on a ReferenceTarget. More...
virtual CoreExport	~ReferenceTarget ()=0
	Destructor. More...
Protected Member Functions inherited from ReferenceMaker
virtual RefResult	NotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID &partID, RefMessage message, BOOL propagate)=0
	Receives and responds to messages. More...
virtual CoreExport	~ReferenceMaker ()=0
	Destructor. More...
virtual CoreExport void	SetReference (int i, RefTargetHandle rtarg)
	Stores a ReferenceTarget as its 'i-th' reference`. More...
void	BlockEval ()
	Validates a given reference link between this reference maker and its reference target. More...
void	UnblockEval ()
	Validates a given reference link between this reference maker and its reference target. More...
int	Evaluating ()
	Validates a given reference link between this reference maker and its reference target. More...
CoreExport RefResult	StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
	Validates a given reference link between this reference maker and its reference target. More...
Protected Member Functions inherited from Animatable
virtual CoreExport	~Animatable ()=0
	Destructor. More...
Protected Member Functions inherited from Noncopyable
	Noncopyable ()
	~Noncopyable ()
Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray	mRenderItemHandles
Protected Attributes inherited from Animatable
DWORD	aflag
AnimPropertyList	aprops

Detailed Description

This is the base class from which plug-in lights may be derived.

See also

Class Object, Class ObjLightDesc, Class Interval, Class Texmap.

Member Function Documentation

SuperClassID()

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.

{ return LIGHT_CLASS_ID; }

IsRenderable()

int IsRenderable ( )

inlinevirtual

Indicates whether the object may be rendered.

Some objects such as construction grids and helpers should not be rendered and can return zero.

Returns

Nonzero if the object may be rendered; otherwise 0.

Implements Object.

{ return(0);}

InitNodeName()

virtual void InitNodeName ( MSTR &  s )

inlineoverridevirtual

This is the default name of the node when it is created.

Parameters

s	The default name of the node is stored here.

Implements Object.

Reimplemented in MSObjectXtnd< GenLight, MSPluginLight >, and MSPluginObject< GenLight >.

{ s = _M("Light"); }

GetInterface() [1/2]

virtual CoreExport void* GetInterface ( ULONG  id )

overridevirtual

Inherited from Animatable.

Returns a pointer to the interface.

Parameters

id	- The id of the interface.

Returns

A Pointer to the Interface

Reimplemented from Object.

Reimplemented in MSObjectXtnd< GenLight, MSPluginLight >, and MSPluginObject< GenLight >.

GetInterface() [2/2]

virtual CoreExport BaseInterface* GetInterface ( Interface_ID  id )

overridevirtual

Inherited from Animatable.

Returns a pointer to the Base Interface for the interface ID passed.

Parameters

id	- The unique ID of the interface to get

Returns

A Pointer to the Interface

Reimplemented from Object.

Reimplemented in MSObjectXtnd< GenLight, MSPluginLight >, and MSPluginObject< GenLight >.

EvalLightState() [1/2]

virtual RefResult EvalLightState ( TimeValue  time, Interval &  valid, LightState *  ls  )

pure virtual

This method is called to update the passed LightState and validity interval of the light.

Parameters

time	The time to evaluate the light state.
valid	The validity interval of the light about the specified time. This interval should be updated to reflect the validity interval of the light.
ls	A pointer to the LightState structure which describes the properties of the light. This function updates the data in the structure to reflect the properties of the light at the specified time. See Structure LightState.

Returns

REF_SUCCEED if the LightState was updated; otherwise REF_FAIL.

Implemented in MSLightXtnd, and MSPluginLight.

EvalLightState() [2/2]

RefResult EvalLightState ( TimeValue  time, LightState *  ls  )

inline

Remarks

Use this override when validity interval is irrelevant

{ Interval i = FOREVER; return EvalLightState(time, i, ls); }

CreateLightDesc() [1/2]

virtual ObjLightDesc* CreateLightDesc ( INode *  n, BOOL  forceShadowBuffer = FALSE  )

inlinevirtual

When the renderer goes to render the scene it asks all of the lights to create an ObjectLighDesc object.

This is the method that is called to return this object.

Parameters

n	The node pointer of the light.
forceShadowBuffer	Forces the creation of a shadow buffer.

Returns

An instance of ObjectLightDesc. See Class ObjectLightDesc.

Reimplemented in MSLightXtnd, MSPluginLight, and GenLight.

{return NULL;}

CreateLightDesc() [2/2]

virtual ObjLightDesc* CreateLightDesc ( RenderGlobalContext *  rgc, INode *  inode, BOOL  forceShadowBuf = FALSE  )

inlinevirtual

Reimplemented in GenLight.

{return NULL;}

SetUseLight()

virtual void SetUseLight ( int  onOff )

pure virtual

Sets if the light is on or off.

Parameters

onOff

TRUE for on; FALSE for off.

Implemented in MSLightXtnd, and MSPluginLight.

GetUseLight()

virtual BOOL GetUseLight ( void  )

pure virtual

Returns TRUE if the light is on; otherwise FALSE.

Implemented in MSLightXtnd, and MSPluginLight.

SetHotspot()

virtual void SetHotspot ( TimeValue  time, float  f  )

pure virtual

Sets the hotspot to the specified angle at the specified time.

Parameters

time	The time to set the hotspot angle.
f	The angle to set in degrees.

Implemented in MSLightXtnd, and MSPluginLight.

GetHotspot() [1/2]

virtual float GetHotspot ( TimeValue  t, Interval &  valid  )

pure virtual

Retrieves the hotspot angle.

Parameters

t	The time to retrieve the angle.
valid	The validity interval that this method will update to reflect the hotspot setting.

Returns

The hotspot angle (in degrees).

Implemented in MSLightXtnd, and MSPluginLight.

GetHotspot() [2/2]

float GetHotspot ( TimeValue  t )

inline

Retrieves the hotspot angle.

Parameters

t	The time to retrieve the angle.

Returns

The hotspot angle (in degrees).

{ Interval valid(0,0); return GetHotspot(t, valid); }

SetFallsize()

virtual void SetFallsize ( TimeValue  time, float  f  )

pure virtual

Sets the falloff setting of the light.

Parameters

time	The time to set the falloff.
f	The falloff angle in degrees.

Implemented in MSLightXtnd, and MSPluginLight.

GetFallsize() [1/2]

virtual float GetFallsize ( TimeValue  t, Interval &  valid  )

pure virtual

Returns the falloff angle of the light in degrees.

Parameters

t	The time to retrieve the falloff angle.
valid	The validity interval that this method will update to reflect the falloff setting.

Returns

The falloff angle of the light in degrees.

Implemented in MSLightXtnd, and MSPluginLight.

GetFallsize() [2/2]

float GetFallsize ( TimeValue  t )

inline

Returns the falloff angle of the light in degrees.

Parameters

t	The time to retrieve the falloff angle.

Returns

The falloff angle of the light in degrees.

{ Interval valid(0,0); return GetFallsize(t, valid); }

SetAtten()

virtual void SetAtten ( TimeValue  time, int  which, float  f  )

pure virtual

Sets the specified attenuation range distance at the time passed.

Parameters

time	The time to set the attenuation distance.
which	Indicates which distance to set. One of the following values: LIGHT_ATTEN_START - The start range radius. LIGHT_ATTEN_END - The end range radius.
f	The distance to set.

Implemented in MSLightXtnd, and MSPluginLight.

GetAtten() [1/2]

virtual float GetAtten ( TimeValue  t, int  which, Interval &  valid  )

pure virtual

Returns the specified attenuation range distance at the time passed.

Parameters

t	The time to retrieve the attenuation distance.
which	Indicates which distance to retrieve. One of the following values: LIGHT_ATTEN_START - The start range radius. LIGHT_ATTEN_END - The end range radius.
valid	The validity interval that this method will update to reflect the attenuation setting.

Returns

The specified attenuation range distance.

Implemented in MSLightXtnd, and MSPluginLight.

GetAtten() [2/2]

float GetAtten ( TimeValue  t, int  which  )

inline

Returns the specified attenuation range distance at the time passed.

Parameters

t	The time to retrieve the attenuation distance.
which	Indicates which distance to retrieve. One of the following values: LIGHT_ATTEN_START - The start range radius. LIGHT_ATTEN_END - The end range radius.

Returns

The specified attenuation range distance.

{ Interval valid(0,0); return GetAtten(t, which, valid); }

SetTDist()

virtual void SetTDist ( TimeValue  time, float  f  )

pure virtual

Sets the light's target distance.

Parameters

time	The time to set the distance.
f	The distance to set.

Implemented in MSLightXtnd, and MSPluginLight.

GetTDist() [1/2]

virtual float GetTDist ( TimeValue  t, Interval &  valid  )

pure virtual

Retrieves the light's target distance.

Parameters

t	The time to retrieve the distance.
valid	The validity interval that this method will update to reflect the target distance setting.

Returns

The light's target distance.

Implemented in MSLightXtnd, and MSPluginLight.

GetTDist() [2/2]

float GetTDist ( TimeValue  t )

inline

Retrieves the light's target distance.

Parameters

t	The time to retrieve the distance.

Returns

The light's target distance.

{ Interval valid(0,0); return GetTDist(t, valid); }

SetConeDisplay()

virtual void SetConeDisplay ( int  s, int  notify = TRUE  )

pure virtual

Sets the light's cone display flag.

This controls if the cone is depicted graphically in the viewports.

Parameters

s	Indicates if the cone display should be on or off. If nonzero, the cone should be displayed; otherwise it should be turned off.
notify	If notify is TRUE the plug-in should call NotifyDependents() to notify its dependents.

Implemented in MSLightXtnd, and MSPluginLight.

GetConeDisplay()

virtual BOOL GetConeDisplay ( void  )

pure virtual

Retrieves the light's cone display setting.

This indicates if the cone is depicted graphically in the viewports.

Returns

TRUE to indicate the cone is displayed; FALSE to indicate it is turned off.

Implemented in MSLightXtnd, and MSPluginLight.

GetShadowMethod()

virtual int GetShadowMethod ( )

inlinevirtual

Returns the type of shadows used by the light.

Returns

One of the following values: LIGHTSHADOW_NONE LIGHTSHADOW_MAPPED LIGHTSHADOW_RAYTRACED

Reimplemented in MSLightXtnd, and MSPluginLight.

{return LIGHTSHADOW_NONE;}

SetRGBColor()

virtual void SetRGBColor ( TimeValue  t, const Point3 &  rgb  )

inlinevirtual

Sets the color of the light at the specified time.

Parameters

t	The time to set the color.
rgb	The color to set.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetRGBColor() [1/2]

virtual Point3 GetRGBColor ( TimeValue  t, Interval &  valid  )

inlinevirtual

Returns the color of the light at the specified time and updates the validity interval to reflect this parameters validity interval.

Parameters

t	The time to retrieve the value.
valid	The validity interval to intersect with this parameters interval.

Returns

The color of the light at the specified time.

Reimplemented in MSLightXtnd, and MSPluginLight.

{ return Point3(0, 0, 0); }

GetRGBColor() [2/2]

Point3 GetRGBColor ( TimeValue  t )

inline

Returns the color of the light at the specified time.

Parameters

t	The time to retrieve the value.

Returns

The color of the light at the specified time.

{ Interval valid(0,0); return GetRGBColor(t, valid); }

SetIntensity()

virtual void SetIntensity ( TimeValue  time, float  f  )

inlinevirtual

Sets the intensity of the light to the value passed.

Parameters

time	The time to set the value.
f	The value to set.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetIntensity() [1/2]

virtual float GetIntensity ( TimeValue  t, Interval &  valid  )

inlinevirtual

Retrieves the intensity of the light at the specified time and updates the validity interval passed to reflect the validity interval of this parameter.

Parameters

t	The time to retrieve the value.
valid	The validity interval to intersect with this parameters interval.

Returns

The intensity of the light at the specified time

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0.0f;}

GetIntensity() [2/2]

float GetIntensity ( TimeValue  t )

inline

Retrieves the intensity of the light at the specified time.

Parameters

t	The time to retrieve the value.

Returns

The intensity of the light at the specified time

{ Interval valid(0,0); return GetIntensity(t, valid); }

SetAspect()

virtual void SetAspect ( TimeValue  t, float  f  )

inlinevirtual

Sets the aspect ratio of the light at the specified time.

Parameters

t	The time to set the value.
f	The value to set.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetAspect() [1/2]

virtual float GetAspect ( TimeValue  t, Interval &  valid  )

inlinevirtual

Retrieves the aspect ratio of the light at the specified time and updates the validity interval passed to reflect the validity interval of this parameter.

Parameters

t	The time to retrieve the value.
valid	The validity interval to intersect with this parameters interval.

Returns

The aspect ratio of the light at the specified time

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0.0f;}    

GetAspect() [2/2]

float GetAspect ( TimeValue  t )

inline

Retrieves the aspect ratio of the light at the specified time.

Parameters

t	The time to retrieve the value.

Returns

The aspect ratio of the light at the specified time

{ Interval valid(0,0); return GetAspect(t, valid); }

SetUseAtten()

virtual void SetUseAtten ( int  s )

inlinevirtual

Sets the flag to indicate if the light is attenuated.

Parameters

s	Nonzero to indicate the light is attenuated; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetUseAtten()

virtual BOOL GetUseAtten ( void  )

inlinevirtual

Returns TRUE to indicate the light is attenuated; otherwise FALSE.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return FALSE;}

SetAttenDisplay()

virtual void SetAttenDisplay ( int  s )

inlinevirtual

Sets the flag to indicate if the light attenuation ranges are displayed.

Parameters

s	Nonzero to indicate the light attenuation ranges are displayed; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetAttenDisplay()

virtual BOOL GetAttenDisplay ( void  )

inlinevirtual

Returns TRUE if the light attenuation ranges are displayed; otherwise FALSE.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return FALSE;}      

Enable()

virtual void Enable ( int  enab )

inlinevirtual

Sets the light to enabled or disables (on or off).

Parameters

enab	Nonzero to set the light to on; zero to turn the light off.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

SetMapBias()

virtual void SetMapBias ( TimeValue  t, float  f  )

inlinevirtual

Sets the map bias setting at the time passed.

Parameters

t	The time to set the value.
f	The map bias value to set. The 3ds Max lights use a range of 0.0 to 100.0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetMapBias() [1/2]

virtual float GetMapBias ( TimeValue  t, Interval &  valid  )

inlinevirtual

Returns the map bias setting at the time passed and updates the validity interval to reflect the validity interval of this parameter.

Parameters

t	The time to retrieve the value.
valid	The validity interval to update to reflect this parameters validity interval.

Returns

The map bias setting at the time passed.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0.0f;}

GetMapBias() [2/2]

float GetMapBias ( TimeValue  t )

inline

Returns the map bias setting at the time passed.

Parameters

t	The time to retrieve the value.

Returns

The map bias setting at the time passed.

{ Interval valid(0,0); return GetMapBias(t, valid); }

SetMapRange()

virtual void SetMapRange ( TimeValue  t, float  f  )

inlinevirtual

Sets the map sample range setting to the value passed at the time passed.

Parameters

t	The time to set the value.\
f	The value to set. The 3ds Max lights use a range of 0.0 to 20.0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetMapRange() [1/2]

virtual float GetMapRange ( TimeValue  t, Interval &  valid  )

inlinevirtual

Retrieves the lights map sample range setting at the specified time and updates the validity interval to reflect the validity interval of this parameter.

Parameters

t	The time to retrieve the value.
valid	The validity interval to update to reflect this parameters validity interval.

Returns

The lights map sample range setting.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0.0f;}

GetMapRange() [2/2]

float GetMapRange ( TimeValue  t )

inline

Retrieves the lights map sample range setting at the specified time.

Parameters

t	The time to retrieve the value.

Returns

The lights map sample range setting.

{ Interval valid(0,0); return GetMapRange(t, valid); }

SetMapSize()

virtual void SetMapSize ( TimeValue  t, int  f  )

inlinevirtual

Sets the lights map size parameter to the value passed at the time passed.

Parameters

t	The time to set the value.
f	The value to set.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetMapSize() [1/2]

virtual int GetMapSize ( TimeValue  t, Interval &  valid  )

inlinevirtual

Returns the lights map size parameter at the specified time and updates the validity interval passed to reflect the validity interval of this parameter.

Parameters

t	The time to retrieve the value.
valid	The validity interval to update to reflect this parameters validity interval.

Returns

The lights map size parameter.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

GetMapSize() [2/2]

int GetMapSize ( TimeValue  t )

inline

Returns the lights map size parameter at the specified time.

Parameters

t	The time to retrieve the value.

Returns

The lights map size parameter.

{ Interval valid(0,0); return GetMapSize(t, valid); }

SetRayBias()

virtual void SetRayBias ( TimeValue  t, float  f  )

inlinevirtual

Sets the raytrace bias setting to the value passed at the specified time.

Parameters

t	The time to set the value.
f	The value to set.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetRayBias() [1/2]

virtual float GetRayBias ( TimeValue  t, Interval &  valid  )

inlinevirtual

Returns the lights raytrace bias setting at the specified time and updates the validity interval passed to reflect the validity interval of this parameter.

Parameters

t	The time to retrieve the value.
valid	The validity interval to update to reflect this parameters validity interval.

Returns

The lights raytrace bias setting at the specified time.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0.0f;}

GetRayBias() [2/2]

float GetRayBias ( TimeValue  t )

inline

Returns the lights raytrace bias setting at the specified time.

Parameters

t	The time to retrieve the value.

Returns

The lights raytrace bias setting at the specified time.

{ Interval valid(0,0); return GetRayBias(t, valid); }

GetUseGlobal()

virtual int GetUseGlobal ( )

inlinevirtual

Returns the Use Global Settings flag setting.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

SetUseGlobal()

virtual void SetUseGlobal ( int  a )

inlinevirtual

Sets the lights Use Global Settings flag.

Parameters

a	Nonzero indicates the light uses the global settings; zero indicates the light uses its own settings.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetShadow()

virtual int GetShadow ( )

inlinevirtual

Returns the lights Cast Shadows flag.

Returns

Nonzero indicates the light casts shadows; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

SetShadow()

virtual void SetShadow ( int  a )

inlinevirtual

Sets the lights Cast Shadows flag.

Parameters

a	Nonzero indicates the light casts shadows; zero indicates the light does not cast shadows.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetShadowType()

virtual int GetShadowType ( )

inlinevirtual

Retrieves the type of shadows used by the light - mapped or raytraced.

Returns

One of the following values: -1: if the Shadow Generator is NULL. (R3 only). 0: if the light uses Shadow Maps. 1: if the light uses Raytraced Shadows. 0xffff: for any other Shadow Generators. (R3 only).

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

SetShadowType()

virtual void SetShadowType ( int  a )

inlinevirtual

Sets the type of shadows used by the light - mapped or raytraced.

Parameters

a	One of the following values: 0: This value plugs in a Shadow Map Generator 1: This value plugs in a Raytraced Shadow Generator. Any other value is a NOOP.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetAbsMapBias()

virtual int GetAbsMapBias ( )

inlinevirtual

Returns the lights Absolute Map Bias setting.

Returns

Nonzero indicates Absolute Map Bias is on; zero indicates it is off.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

SetAbsMapBias()

virtual void SetAbsMapBias ( int  a )

inlinevirtual

Sets the lights Absolute Map Bias setting.

Parameters

a	Nonzero indicates Absolute Map Bias is on; zero indicates it is off.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetOvershoot()

virtual int GetOvershoot ( )

inlinevirtual

Returns the lights Overshoot on / off setting.

Nonzero indicates overshoot is on; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

SetOvershoot()

virtual void SetOvershoot ( int  a )

inlinevirtual

Sets the lights Overshoot on / off setting.

Parameters

a	Nonzero indicates overshoot is on; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetProjector()

virtual int GetProjector ( )

inlinevirtual

Returns the lights Projector on / off setting.

Nonzero indicates this light projects an image; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return 0;}

SetProjector()

virtual void SetProjector ( int  a )

inlinevirtual

Sets the lights projector on / off setting.

Parameters

a	Nonzero indicates this light projects an image; otherwise 0.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

GetExclList()

virtual ExclList* GetExclList ( )

inlinevirtual

Returns the list of names of items included or excluded by this light.

See Class NameTab.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return NULL;}

Include()

virtual BOOL Include ( )

inlinevirtual

Returns TRUE if the light's name list is of items to be included by the light.

Returns FALSE if the list is of items to exclude from the light.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return FALSE;}

GetProjMap()

virtual Texmap* GetProjMap ( )

inlinevirtual

Returns the map used by a projector light.

Reimplemented in MSLightXtnd, and MSPluginLight.

{return NULL;}

SetProjMap()

virtual void SetProjMap ( Texmap *  pmap )

inlinevirtual

Sets the image(s) used by the projector light.

Parameters

pmap	The map to use.

Reimplemented in MSLightXtnd, and MSPluginLight.

{}

UpdateTargDistance()

virtual void UpdateTargDistance ( TimeValue  t, INode *  inode  )

inlinevirtual

Updates the display of the light's target distance in the light's rollup page.

Parameters

t	The time to retrieve the distance.
inode	The light node.

Reimplemented in LightscapeLight, MSLightXtnd, and MSPluginLight.

{}