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

Extension to Photometric light This interface extends class LightscapeLight with new functionality in 3ds Max 2016. More...

#include <lslights.h>

+ Inheritance diagram for LightscapeLight2:

Public Member Functions

virtual bool BakeWebDistribution (MaxSDK::Array< float > &bakedDistribution, size_t &bakedWidth, size_t &bakedHeight)=0
 Bakes a web distribution into a spherical map.
 
- Public Member Functions inherited from LightscapeLight
virtual void SetInclude (BOOL onOff)=0
 Sets whether the Include/Exclude list should include or exclude objects.
 
virtual void UpdateTargDistance (TimeValue t, INode *inode)=0
 Update the target distance parameter of the light to the distance between the light target and the light.
 
virtual Point3 GetCenter () const =0
 Returns the location of the center of the light.
 
virtual void SetType (int type)=0
 Sets the light type.
 
virtual void SetType (const MCHAR *name)=0
 Sets the light type.
 
virtual int Type ()=0
 Returns the current light type.
 
virtual const MCHARTypeName ()=0
 Returns the light type.
 
virtual void SetDistribution (DistTypes dist)=0
 Sets the distribution of the light.
 
virtual DistTypes GetDistribution () const =0
 Returns the distribution of the light.
 
virtual void SetIntensityAt (float f)=0
 Sets the distance at which the light intensity is measured.
 
virtual float GetIntensityAt ()=0
 Returns the distance at which the light intensity is measured.
 
virtual void SetIntensityType (IntensityType t)=0
 Sets the intensity type of the light.
 
virtual IntensityType GetIntensityType ()=0
 Returns the intensity type of the light.
 
virtual void SetFlux (TimeValue t, float flux)=0
 Sets the flux of the light.
 
virtual float GetFlux (TimeValue t, Interval &valid) const =0
 Returns the flux of the light.
 
float GetFlux (TimeValue t) const
 Returns the flux of the light.
 
virtual void SetRGBFilter (TimeValue t, const Point3 &rgb)=0
 Sets the color of the light filter.
 
virtual Point3 GetRGBFilter (TimeValue t, Interval &valid)=0
 Returns the color of the light filter.
 
Point3 GetRGBFilter (TimeValue t)
 Returns the color of the light filter.
 
virtual void SetHSVFilter (TimeValue t, Point3 &hsv)=0
 Sets the color of the light filter.
 
virtual Point3 GetHSVFilter (TimeValue t, Interval &valid)=0
 Returns the color of the light filter.
 
Point3 GetHSVFilter (TimeValue t)
 Returns the color of the light filter.
 
virtual ShadowTypeActiveShadowType ()=0
 Returns the plug-in shadow generator.
 
virtual const MCHARGetShadowGeneratorName ()=0
 Returns the plug-in shadow generator name.
 
virtual void SetShadowGenerator (ShadowType *s) override=0
 Sets the plug-in shadow generator.
 
virtual void SetShadowGenerator (const MCHAR *name)=0
 Sets the plug-in shadow generator.
 
virtual BOOL SetKelvinControl (Control *kelvin)=0
 Sets the controller for the Kelvin temperature.
 
virtual BOOL SetFilterControl (Control *filter)=0
 Sets the controller for the filter color.
 
virtual ControlGetKelvinControl ()=0
 Returns the controller for the Kelvin temperature.
 
virtual ControlGetFilterControl ()=0
 Returns the controller for the filter color.
 
virtual float GetKelvin (TimeValue t, Interval &v)=0
 Returns the Kelvin temperature of the light.
 
float GetKelvin (TimeValue t)
 Returns the Kelvin temperature of the light.
 
virtual void SetKelvin (TimeValue t, float kelvin)=0
 Sets the Kelvin temperature of the light.
 
virtual BOOL GetUseKelvin ()=0
 Returns whether the kelvin temperature or light color is to be used.
 
virtual void SetUseKelvin (BOOL useKelvin)=0
 Sets whether the kelvin temperature or light color is to be used.
 
virtual MaxSDK::AssetManagement::AssetUser GetWebFile () const =0
 Returns the web distribution file for the light as an AssetUser.
 
virtual const MCHARGetFullWebFileName () const =0
 Returns the filename of the web distribution file for the light.
 
virtual void SetWebFile (const MaxSDK::AssetManagement::AssetUser &file)=0
 Sets the web distribution file for the light.
 
virtual float GetWebRotateX () const =0
 Returns the rotation along the X axis of the web distribution in the light.
 
virtual void SetWebRotateX (float degrees)=0
 Sets the rotation along the X axis for the web distribution in the light.
 
virtual float GetWebRotateY () const =0
 Returns the rotation along the Y axis of the web distribution in the light.
 
virtual void SetWebRotateY (float degrees)=0
 Sets the rotation along the Y axis for the web distribution in the light.
 
virtual float GetWebRotateZ () const =0
 Returns the rotation along the Z axis of the web distribution in the light.
 
virtual void SetWebRotateZ (float degrees)=0
 Sets the rotation along the Z axis for the web distribution in the light.
 
virtual float GetDimmerValue (TimeValue t, Interval &valid) const =0
 Returns the dimmer value for the light.
 
float GetDimmerValue (TimeValue t) const
 Returns the dimmer value for the light.
 
virtual void SetDimmerValue (TimeValue t, float dimmer)=0
 Sets the dimmer value for the light.
 
virtual BOOL GetUseMultiplier () const =0
 Returns whether the dimmer is used.
 
virtual void SetUseMultiplier (BOOL on)=0
 Sets whether the dimmer is used.
 
virtual BOOL IsColorShiftEnabled () const =0
 Returns whether the light's intensity shifts (affects) its color.
 
virtual void EnableColorShift (BOOL on)=0
 Sets whether the color of the light shifts when its intensity changes Note that this parameter is really activated only if GetUseMultiplier() is true.
 
virtual float GetResultingIntensity (TimeValue t, Interval &valid) const =0
 Returns the intensity including the dimmer multiplier if it is used.
 
float GetResultingIntensity (TimeValue t) const
 Returns the intensity including the dimmer multiplier if it is used.
 
virtual float GetResultingFlux (TimeValue t, Interval &valid) const =0
 Returns the flux including the dimmer multiplier if it is used.
 
float GetResultingFlux (TimeValue t) const
 Returns the flux including the dimmer multiplier if it is used.
 
virtual float GetRadius (TimeValue t, Interval &valid) const =0
 Returns the radius of a disc, sphere, cylinder light.
 
float GetRadius (TimeValue t) const
 Returns the radius of a disc, sphere, cylinder light.
 
virtual void SetRadius (TimeValue t, float radius)=0
 Sets the radius of a disc, sphere, cylinder light.
 
virtual float GetLength (TimeValue t, Interval &valid) const =0
 Returns the length of a linear, area, cylinder light.

 
float GetLength (TimeValue t) const
 Returns the length of a linear, area, cylinder light.
 
virtual void SetLength (TimeValue t, float length)=0
 Sets the length of a linear, area, cylinder light.
 
virtual float GetWidth (TimeValue t, Interval &valid) const =0
 Returns the width of an area light.

 
float GetWidth (TimeValue t) const
 Returns the width of an area light.
 
virtual void SetWidth (TimeValue t, float width)=0
 Sets the width of an area light.
 
virtual void SetShape (int count, const Point3 *pointsIn)=0
 Sets the coordinates of the light.
 
virtual int GetShape (Point3 *pointsOut, int bufSize) const =0
 Returns the coordinates of the light.
 
virtual float GetOriginalFlux () const =0
 Returns the original flux for a light.
 
virtual void SetOriginalFlux (float flux)=0
 Sets the original flux for a light.
 
virtual float GetOriginalIntensity () const =0
 Returns the original intensity for a light.
 
virtual void SetOriginalIntensity (float candelas)=0
 Sets the original intensity for a light.
 
virtual PresetLightColor GetColorPreset () const =0
 Returns the color preset of the light.
 
virtual void SetColorPreset (PresetLightColor presetID)=0
 Sets the preset color of the light to be used.
 
- Public Member Functions inherited from GenLight
virtual GenLightNewLight (int type)=0
 
virtual int Type ()=0
 
virtual void SetType (int tp)
 
virtual BOOL IsSpot ()=0
 
virtual BOOL IsDir ()=0
 
virtual void SetSpotShape (int s)=0
 
virtual int GetSpotShape (void)=0
 
virtual ObjLightDescCreateLightDesc (INode *inode, BOOL forceShadowBuf=FALSE) override=0
 When the renderer goes to render the scene it asks all of the lights to create an ObjectLighDesc object.
 
virtual ObjLightDescCreateLightDesc (RenderGlobalContext *rgc, INode *inode, BOOL forceShadowBuf=FALSE) override
 
virtual void SetHSVColor (TimeValue t, Point3 &hsv)=0
 
virtual Point3 GetHSVColor (TimeValue t, Interval &valid)=0
 
Point3 GetHSVColor (TimeValue t)
 
virtual void SetContrast (TimeValue time, float f)=0
 
virtual float GetContrast (TimeValue t, Interval &valid)=0
 
float GetContrast (TimeValue t)
 
virtual void SetUseAttenNear (int s)=0
 
virtual BOOL GetUseAttenNear (void)=0
 
virtual void SetAttenNearDisplay (int s)=0
 
virtual BOOL GetAttenNearDisplay (void)=0
 
virtual void SetShadowGenerator (ShadowType *s)
 
virtual ShadowTypeGetShadowGenerator ()
 
virtual void SetAtmosShadows (TimeValue t, int onOff)
 
virtual int GetAtmosShadows (TimeValue t)
 
virtual void SetAtmosOpacity (TimeValue t, float f)
 
virtual float GetAtmosOpacity (TimeValue t, Interval &valid)
 
float GetAtmosOpacity (TimeValue t)
 
virtual void SetAtmosColAmt (TimeValue t, float f)
 
virtual float GetAtmosColAmt (TimeValue t, Interval &valid)
 
float GetAtmosColAmt (TimeValue t)
 
virtual void SetUseShadowColorMap (TimeValue t, int onOff)
 
virtual int GetUseShadowColorMap (TimeValue t)
 
virtual ExclListGetExclusionList ()=0
 
virtual void SetExclusionList (ExclList &list)=0
 
virtual BOOL SetHotSpotControl (Control *c)=0
 
virtual BOOL SetFalloffControl (Control *c)=0
 
virtual BOOL SetColorControl (Control *c)=0
 
virtual ControlGetHotSpotControl ()=0
 
virtual ControlGetFalloffControl ()=0
 
virtual ControlGetColorControl ()=0
 
virtual void SetAffectDiffuse (BOOL onOff)
 
virtual BOOL GetAffectDiffuse ()
 
virtual void SetAffectSpecular (BOOL onOff)
 
virtual BOOL GetAffectSpecular ()
 
virtual void SetDecayType (BOOL onOff)
 
virtual BOOL GetDecayType ()
 
virtual void SetDecayRadius (TimeValue time, float f)
 
virtual float GetDecayRadius (TimeValue t, Interval &valid)
 
float GetDecayRadius (TimeValue t)
 
virtual void SetDiffuseSoft (TimeValue time, float f)
 
virtual float GetDiffuseSoft (TimeValue t, Interval &valid)
 
float GetDiffuseSoft (TimeValue t)
 
virtual void SetShadColor (TimeValue t, const Point3 &rgb)
 
virtual Point3 GetShadColor (TimeValue t, Interval &valid)
 
Point3 GetShadColor (TimeValue t)
 
virtual BOOL GetLightAffectsShadow ()
 
virtual void SetLightAffectsShadow (BOOL b)
 
virtual void SetShadMult (TimeValue t, float m)
 
virtual float GetShadMult (TimeValue t, Interval &valid)
 
float GetShadMult (TimeValue t)
 
virtual TexmapGetShadowProjMap ()
 
virtual void SetShadowProjMap (Texmap *pmap)
 
virtual void SetAmbientOnly (BOOL onOff)
 
virtual BOOL GetAmbientOnly ()
 
- Public Member Functions inherited from LightObject
SClass_ID SuperClassID ()
 Retrieves a constant representing the type of the plugin.
 
int IsRenderable ()
 Indicates whether the object may be rendered.
 
virtual void InitNodeName (MSTR &s) override
 This is the default name of the node when it is created.
 
virtual CoreExport voidGetInterface (ULONG id) override
 
virtual CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
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.
 
RefResult EvalLightState (TimeValue time, LightState *ls)
 
RefResult EvalLightState (TimeValue time, Interval &&, LightState *ls)
 
virtual ObjLightDescCreateLightDesc (INode *n, BOOL forceShadowBuffer=FALSE)
 When the renderer goes to render the scene it asks all of the lights to create an ObjectLighDesc object.
 
virtual ObjLightDescCreateLightDesc (RenderGlobalContext *rgc, INode *inode, BOOL forceShadowBuf=FALSE)
 
virtual void SetUseLight (int onOff)=0
 Sets if the light is on or off.
 
virtual BOOL GetUseLight (void)=0
 Returns TRUE if the light is on; otherwise FALSE.
 
virtual void SetHotspot (TimeValue time, float f)=0
 Sets the hotspot to the specified angle at the specified time.
 
virtual float GetHotspot (TimeValue t, Interval &valid)=0
 Retrieves the hotspot angle.
 
float GetHotspot (TimeValue t)
 Retrieves the hotspot angle.
 
virtual void SetFallsize (TimeValue time, float f)=0
 Sets the falloff setting of the light.
 
virtual float GetFallsize (TimeValue t, Interval &valid)=0
 Returns the falloff angle of the light in degrees.
 
float GetFallsize (TimeValue t)
 Returns the falloff angle of the light in degrees.
 
virtual void SetAtten (TimeValue time, int which, float f)=0
 Sets the specified attenuation range distance at the time passed.
 
virtual float GetAtten (TimeValue t, int which, Interval &valid)=0
 Returns the specified attenuation range distance at the time passed.
 
float GetAtten (TimeValue t, int which)
 Returns the specified attenuation range distance at the time passed.
 
virtual void SetTDist (TimeValue time, float f)=0
 Sets the light's target distance.
 
virtual float GetTDist (TimeValue t, Interval &valid)=0
 Retrieves the light's target distance.
 
float GetTDist (TimeValue t)
 Retrieves the light's target distance.
 
virtual void SetConeDisplay (int s, int notify=TRUE)=0
 Sets the light's cone display flag.
 
virtual BOOL GetConeDisplay (void)=0
 Retrieves the light's cone display setting.
 
virtual int GetShadowMethod ()
 Returns the type of shadows used by the light.
 
virtual void SetRGBColor (TimeValue t, const Point3 &rgb)
 Sets the color of the light at the specified time.
 
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.
 
Point3 GetRGBColor (TimeValue t)
 Returns the color of the light at the specified time.
 
virtual void SetIntensity (TimeValue time, float f)
 Sets the intensity of the light to the value passed.
 
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.
 
float GetIntensity (TimeValue t)
 Retrieves the intensity of the light at the specified time.
 
virtual void SetAspect (TimeValue t, float f)
 Sets the aspect ratio of the light at the specified time.
 
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.
 
float GetAspect (TimeValue t)
 Retrieves the aspect ratio of the light at the specified time.
 
virtual void SetUseAtten (int s)
 Sets the flag to indicate if the light is attenuated.
 
virtual BOOL GetUseAtten (void)
 Returns TRUE to indicate the light is attenuated; otherwise FALSE.
 
virtual void SetAttenDisplay (int s)
 Sets the flag to indicate if the light attenuation ranges are displayed.
 
virtual BOOL GetAttenDisplay (void)
 Returns TRUE if the light attenuation ranges are displayed; otherwise FALSE.
 
virtual void Enable (int enab)
 Sets the light to enabled or disables (on or off).
 
virtual void SetMapBias (TimeValue t, float f)
 Sets the map bias setting at the time passed.
 
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.
 
float GetMapBias (TimeValue t)
 Returns the map bias setting at the time passed.
 
virtual void SetMapRange (TimeValue t, float f)
 Sets the map sample range setting to the value passed at the time passed.
 
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.
 
float GetMapRange (TimeValue t)
 Retrieves the lights map sample range setting at the specified time.
 
virtual void SetMapSize (TimeValue t, int f)
 Sets the lights map size parameter to the value passed at the time passed.
 
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.
 
int GetMapSize (TimeValue t)
 Returns the lights map size parameter at the specified time.
 
virtual void SetRayBias (TimeValue t, float f)
 Sets the raytrace bias setting to the value passed at the specified time.
 
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.
 
float GetRayBias (TimeValue t)
 Returns the lights raytrace bias setting at the specified time.
 
virtual int GetUseGlobal ()
 Returns the Use Global Settings flag setting.
 
virtual void SetUseGlobal (int a)
 Sets the lights Use Global Settings flag.
 
virtual int GetShadow ()
 Returns the lights Cast Shadows flag.
 
virtual void SetShadow (int a)
 Sets the lights Cast Shadows flag.
 
virtual int GetShadowType ()
 Retrieves the type of shadows used by the light - mapped or raytraced.
 
virtual void SetShadowType (int a)
 Sets the type of shadows used by the light - mapped or raytraced.
 
virtual int GetAbsMapBias ()
 Returns the lights Absolute Map Bias setting.
 
virtual void SetAbsMapBias (int a)
 Sets the lights Absolute Map Bias setting.
 
virtual int GetOvershoot ()
 Returns the lights Overshoot on / off setting.
 
virtual void SetOvershoot (int a)
 Sets the lights Overshoot on / off setting.
 
virtual int GetProjector ()
 Returns the lights Projector on / off setting.
 
virtual void SetProjector (int a)
 Sets the lights projector on / off setting.
 
virtual ExclListGetExclList ()
 Returns the list of names of items included or excluded by this light.
 
virtual BOOL Include ()
 Returns TRUE if the light's name list is of items to be included by the light.
 
virtual TexmapGetProjMap ()
 Returns the map used by a projector light.
 
virtual void SetProjMap (Texmap *pmap)
 Sets the image(s) used by the projector light.
 
virtual void UpdateTargDistance (TimeValue t, INode *inode)
 Updates the display of the light's target distance in the light's rollup page.
 
- Public Member Functions inherited from Object
CoreExport Object ()
 
CoreExport ~Object ()
 
virtual BOOL CheckObjectIntegrity ()
 This method is used for debugging only.
 
virtual BOOL HasUVW () override
 Call this method to find out if the object has UVW coordinates.
 
virtual BOOL HasUVW (int mapChannel) override
 Call this method to find out if the object is has UVW coordinates for the specified mapping channel.
 
virtual ObjectFindBaseObject ()
 It is called to return a pointer to the base object (an object that is not a derived object).
 
virtual BOOL IsParamSurface ()
 There are several methods used to access a parametric position on the surface of the object.
 
virtual int NumSurfaces (TimeValue t)
 Returns the number of parametric surfaces within the object.
 
virtual Point3 GetSurfacePoint (TimeValue t, float u, float v, Interval &iv)
 This method needs to be implemented if Object::IsParamSurface() returns TRUE.
 
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.
 
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.
 
virtual BOOL GetExtendedProperties (TimeValue t, MSTR &prop1Label, MSTR &prop1Data, MSTR &prop2Label, MSTR &prop2Data)
 This method allows an object to return extended Properties fields.
 
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.
 
CoreExport MultiSelectCallbackSvGetMultiSelectCallback (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.
 
CoreExport int NumXTCObjects ()
 Returns the number of extension objects maintained by this Object.
 
CoreExport XTCObjectGetXTCObject (int index)
 Returns a pointer to the specified extension object.
 
CoreExport void RemoveXTCObject (int index)
 Removes the extension object as indicated by the index.
 
CoreExport void SetXTCObjectPriority (int index, int priority)
 Sets the priority for the extension object whose index is passed.
 
CoreExport int GetXTCObjectPriority (int index)
 Returns the integer priority number of the extension object whose index is passed.
 
CoreExport void SetXTCObjectBranchID (int index, int branchID)
 Sets the branch ID of the extension object whose index is passed.
 
CoreExport int GetXTCObjectBranchID (int index)
 Returns the integer branch ID of the extension object whose index is passed.
 
CoreExport void MergeAdditionalChannels (Object *from, int branchID)
 This method has to be called whenever the CompoundObject updates a branch (calling Eval() on it).
 
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.
 
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.
 
CoreExport void DeleteAllAdditionalChannels ()
 Implemented by the System.
 
virtual BOOL UseSelectionBrackets ()
 This method allows an object to choose whether or not it will display selection brackets in shaded viewports.
 
virtual BOOL IsManipulator ()
 
CoreExport voidGetInterface (ULONG id) override
 
CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
virtual void ReduceDisplayCaches ()
 Should reduce any derived display data to save memory, since the node wont be drawn until the user undhides it.
 
virtual bool NeedGWCacheRebuilt (GraphicsWindow *gw, Material *ma, int numMat)
 This returns whether the Graphics Cache for this object needs to be rebuilt.
 
virtual void BuildGWCache (GraphicsWindow *gw, Material *ma, int numMat, BOOL threaded)
 This builds the graphics window cached mesh.
 
virtual void StartStackEval ()
 This are called right before and after a modifier is applied to an object.
 
virtual void EndStackEval ()
 
virtual int UsesWireColor ()
 This method determines if the object color is used for display.
 
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.
 
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.
 
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.
 
void LockObject ()
 Implemented by the System.
 
void UnlockObject ()
 Implemented by the System.
 
int IsObjectLocked ()
 Implemented by the System.
 
virtual ObjectState Eval (TimeValue t)=0
 This method is called to evaluate the object and return the result as an ObjectState.
 
void LockChannels (ChannelMask channels)
 Implemented by the System.
 
void UnlockChannels (ChannelMask channels)
 Implemented by the System.
 
ChannelMask GetChannelLocks ()
 Implemented by the System.
 
void SetChannelLocks (ChannelMask channels)
 Implemented by the System.
 
ChannelMask GetChannelLocks (ChannelMask m)
 Implemented by the System.
 
virtual BOOL CanCacheObject ()
 This method determines if this object can have channels cached.
 
virtual void WSStateInvalidate ()
 This is called by a node when the node's world space state has become invalid.
 
virtual BOOL IsWorldSpaceObject ()
 Returns TRUE if the object as a world space object; otherwise FALSE.
 
CoreExport INodeGetWorldSpaceObjectNode ()
 Implemented by the System.
 
virtual BOOL IsParticleSystem ()
 Implemented by the System.
 
CoreExport void CopyChannelLocks (Object *obj, ChannelMask needChannels)
 Implemented by the System.
 
virtual void TopologyChanged ()
 Implemented by the System.
 
virtual int IsDeformable ()
 Indicates whether this object is deformable.
 
virtual int NumPoints ()
 The points of a deformable object are accessed through a virtual array interface.
 
virtual Point3 GetPoint (int i)
 The points of a deformable object are accessed through a virtual array interface.
 
virtual void SetPoint (int i, const Point3 &p)
 The points of a deformable object are accessed through a virtual array interface.
 
virtual BOOL IsPointSelected (int i)
 Returns TRUE if the 'i-th' point is selected; otherwise FALSE.
 
virtual float PointSelection (int i)
 Returns a floating point weighted point selection if the object supports it.
 
virtual BOOL HasWeights ()
 Returns TRUE if the object has weights for its points that can be set; otherwise FALSE.
 
virtual double GetWeight (int i)
 Returns the weight of the specified point of the object.
 
virtual void SetWeight (int i, const double w)
 Sets the weight of the specified point.
 
virtual BOOL PolygonCount (TimeValue t, int &numFaces, int &numVerts)
 Retreives the number of faces and vertices of the polyginal mesh representation of this object.
 
virtual void PointsWereChanged ()
 Informs the object that its points have been deformed, so it can invalidate its cache.
 
virtual CoreExport void Deform (Deformer *defProc, int useSel=0)
 This is the method used to deform the object with a deformer.
 
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.
 
virtual int IsMappable ()
 This method lets you know if the ApplyUVWMap() method is available for this object.
 
virtual int NumMapChannels ()
 Returns the maximum number of channels supported by this type of object.
 
virtual int NumMapsUsed ()
 Returns the number of maps currently used by this object.
 
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.
 
virtual CoreExport int CanConvertToType (Class_ID obtype)
 Indicates whether the object can be converted to the specified type.
 
virtual CoreExport ObjectConvertToType (TimeValue t, Class_ID obtype)
 This method converts this object to the type specified and returns a pointer it.
 
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.
 
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.
 
virtual ObjectCollapseObject ()
 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.
 
virtual DWORD GetSubselState ()
 For objects that have sub selection levels, this method returns the current selection level of the object.
 
virtual void SetSubSelState (DWORD s)
 Implemented by the System.
 
CoreExport void ReadyChannelsForMod (ChannelMask channels)
 Implemented by the System.
 
virtual CoreExport Interval ChannelValidity (TimeValue t, int nchan)
 Retrieve the current validity interval for the nchan channel of the object.
 
virtual CoreExport void SetChannelValidity (int nchan, Interval v)
 Sets the validity interval of the specified channel.
 
virtual CoreExport void InvalidateChannels (ChannelMask channels)
 This method invalidates the intervals for the given channel mask.
 
virtual CoreExport Interval ObjectValidity (TimeValue t)
 This method returns the validity interval of the object as a whole at the specified time.
 
virtual ObjectMakeShallowCopy (ChannelMask channels)
 This method must make a copy of its "shell" and then shallow copy (see below) only the specified channels.
 
virtual CoreExport void ShallowCopy (Object *fromOb, ChannelMask channels)
 This method copies the specified channels from the fromOb to this and copies the validity intervals.
 
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).
 
virtual CoreExport void NewAndCopyChannels (ChannelMask channels)
 This method replaces the locked channels with newly allocated copies.
 
virtual CoreExport void MaybeEnlargeViewportRect (GraphicsWindow *gw, Rect &rect)
 This method allows the object to enlarge its viewport rectangle, if it wants to.
 
CoreExport bool IsBaseClassOwnedChannel (int nchan)
 Implemented by the System.
 
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.
 
Interval GetNoEvalInterval ()
 
void SetNoEvalInterval (Interval iv)
 
virtual CoreExport void ReduceCaches (TimeValue t)
 This method give the object the chance to reduce its caches.
 
virtual int IsConstObject ()
 This is called to determine if this is a construction object or not.
 
virtual int NumPipeBranches (bool selected=true)
 This method returns the number of pipeline branches combined by the object.
 
virtual ObjectGetPipeBranch (int i, bool selected=true)
 Retrieves sub-object branches from an object that supports branching.
 
virtual INodeGetBranchINode (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.
 
virtual int NumberOfContainedShapes ()
 Returns the number of shapes contained inside this object.
 
virtual ShapeObjectGetContainedShape (TimeValue t, int index)
 This method returns the ShapeObject specified by the index passed at the time specified.
 
virtual void GetContainedShapeMatrix (TimeValue t, int index, Matrix3 &mat)
 Returns the matrix associated with the shape whose index is passed.
 
virtual BitArray ContainedShapeSelectionArray ()
 This is used by the lofter.
 
virtual BOOL IsShapeObject ()
 Returns the number of shapes contained inside this object.
 
- Public Member Functions inherited from BaseObject
virtual CoreExport unsigned long GetObjectDisplayRequirement () const
 
virtual CoreExport bool PrepareDisplay (const MaxSDK::Graphics::UpdateDisplayContext &prepareDisplayContext)
 
virtual CoreExport bool UpdatePerNodeItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport bool UpdatePerViewItems (const MaxSDK::Graphics::UpdateDisplayContext &updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext &nodeContext, MaxSDK::Graphics::UpdateViewContext &viewContext, MaxSDK::Graphics::IRenderItemContainer &targetRenderItemContainer)
 
virtual CoreExport const MaxSDK::Graphics::RenderItemHandleArrayGetRenderItems () const
 
virtual CoreExport voidGetInterface (ULONG id) override
 
virtual CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 
CoreExport BaseObject ()
 
virtual CoreExport ~BaseObject ()
 
virtual BOOL HasViewDependentBoundingBox ()
 This method return true if GetWorldBoundBox returns different boxes for different viewports.
 
virtual 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.
 
virtual void SetExtendedDisplay (int flags)
 This method is used for storing mode-dependent display attributes.
 
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).
 
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.
 
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).
 
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.
 
virtual CreateMouseCallBackGetCreateMouseCallBack ()=0
 This method allows the system to retrieve a callback object used in creating an object in the 3D viewports.
 
 __declspec (deprecated) virtual const MCHAR *GetObjectName() MAX_SEALED
 
virtual const MCHARGetObjectName (bool localized) const
 
virtual CoreExport BOOL OKToChangeTopology (MSTR &modName)
 Implemented by the System.
 
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.
 
virtual void ForceNotify (Interval &i)
 Notifies dependents of a change.
 
virtual IParamArrayGetParamBlock ()
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
virtual IParamBlock2GetParamBlock (int i) override
 An object or modifier should implement this method if it wishes to make its parameter block available for other plug-ins to access it.
 
virtual int GetParamBlockIndex (int id)
 If a plug-in makes its parameter block available (using GetParamBlock()) then it will need to provide #defines for indices into the parameter block.
 
virtual void Move (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by moving its selected sub-object components.
 
virtual void Rotate (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Quat &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by rotating its selected sub-object components.
 
virtual void Scale (TimeValue t, Matrix3 &partm, Matrix3 &tmAxis, Point3 &val, BOOL localOrigin=FALSE)
 When this method is called the plug-in should respond by scaling its selected sub-object components.
 
virtual void TransformStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and before a hold is in effect.
 
virtual void TransformHoldingStart (TimeValue t)
 This method is called before the first Move(), Rotate() or Scale() call and after a hold is in effect.
 
virtual void TransformHoldingFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and before the undo object has been accepted.
 
virtual void TransformFinish (TimeValue t)
 This method is called after the user has completed the Move(), Rotate() or Scale() operation and the undo object has been accepted.
 
virtual void TransformCancel (TimeValue t)
 This method is called when the transform operation is canceled by a right-click and the undo has been canceled.
 
virtual int HitTest (TimeValue t, INode *inode, int type, int crossing, int flags, IPoint2 *p, ViewExp *vpt, ModContext *mc)
 This method is used in modifier gizmo hit testing.
 
virtual int Display (TimeValue t, INode *inode, ViewExp *vpt, int flags, ModContext *mc)
 When this method is called the plug-in should respond by performing a quick render of the modifier gizmo in viewport using the current TM.
 
virtual void GetWorldBoundBox (TimeValue t, INode *inode, ViewExp *vpt, Box3 &box, ModContext *mc)
 This method computes the world space bounding box of the modifier gizmo (or any object that when in sub-object mode has a gizmo).
 
virtual void CloneSelSubComponents (TimeValue t)
 This method is called to make a copy of the selected sub-object components of the item.
 
virtual void AcceptCloneSelSubComponents (TimeValue t)
 This method is called when the user mouses up after shift-cloning a sub-object selection.
 
virtual void SelectSubComponent (HitRecord *hitRec, BOOL selected, BOOL all, BOOL invert=FALSE)
 This method is called to change the selection state of the component identified by hitRec.
 
virtual void ClearSelection (int selLevel)
 This method is called to clear the selection for the given sub-object level.
 
virtual void SelectAll (int selLevel)
 This method is called to select every element of the given sub-object level.
 
virtual void InvertSelection (int selLevel)
 This method is called to invert the specified sub-object level.
 
virtual int SubObjectIndex (HitRecord *hitRec)
 Returns the index of the sub-object element identified by the HitRecord hitRec.
 
virtual void ActivateSubobjSel (int level, XFormModes &modes)
 When the user changes the selection of the sub-object drop down, this method is called to notify the plug-in.
 
virtual BOOL SupportsNamedSubSels ()
 An object that supports sub-object selection can choose to support named sub object selection sets.
 
virtual void ActivateSubSelSet (MSTR &setName)
 When the user chooses a name from the drop down list this method is called.
 
virtual void NewSetFromCurSel (MSTR &setName)
 If the user types a new name into the named selection set drop down then this method is called.
 
virtual void RemoveSubSelSet (MSTR &setName)
 If the user selects a set from the drop down and then chooses Remove Named Selections from the Edit menu this method is called.
 
virtual void SetupNamedSelDropDown ()
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual int NumNamedSelSets ()
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual MSTR GetNamedSelSetName (int i)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void SetNamedSelSetName (int i, MSTR &newName)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void NewSetByOperator (MSTR &newName, Tab< int > &sets, int op)
 To support the Edit Named Selections dialog, plug-ins must implement this method.
 
virtual void GetSubObjectCenters (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
 
virtual void GetSubObjectTMs (SubObjAxisCallback *cb, TimeValue t, INode *node, ModContext *mc)
 When the user is in a sub-object selection level, the system needs to get the reference coordinate system definition from the current modifier being edited so that it can display the axis.
 
virtual void NotifyPreCollapse (INode *node, IDerivedObject *derObj, int index)
 This method is called before a modifier or object is collapsed.
 
virtual void NotifyPostCollapse (INode *node, Object *obj, IDerivedObject *derObj, int index)
 This method is called after a modifier or object is collapsed.
 
virtual int NumSubObjTypes ()
 Objects and modifiers that support subobjects have to overwrite this method - as well as GetSubObjType() - and return a class derived from ISubObjType in GetSubObjType().
 
virtual ISubObjTypeGetSubObjType (int i)
 Returns a pointer to the sub-object type for the sub-object whose index is passed.
 
virtual CoreExport int GetSubObjectLevel ()
 This method returns an integer which indicates the current sub-object level of the modifier or base object.
 
virtual void SetGenUVW (BOOL sw)
 This method is called to change the state of its Generate UVW boolean.
 
virtual void SetGenUVW (int mapChannel, BOOL sw)
 This method is called to change the state of its Generate UVW boolean for the specified mapping channel.
 
virtual void ShowEndResultChanged (BOOL showEndResult)
 This method notifies the BaseObject that the end result display has been switched (the "Show End Result" button has been toggled).
 
- Public Member Functions inherited from ReferenceTarget
CoreExport void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
CoreExport SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
BOOL IsRefTarget () override
 Checks if this is a ReferenceTarget.
 
CoreExport RefResult TestForLoop (const Interval &refInterval, RefMakerHandle hmaker)
 Tests for a cyclical reference.
 
CoreExport BOOL HasDependents ()
 Checks if a ReferenceTarget has references.
 
CoreExport BOOL HasRealDependents ()
 Checks if this has Real (Strong) Dependents.
 
void BeginDependencyTest ()
 Starts Dependency Test.
 
BOOL EndDependencyTest ()
 Ends Dependency Test.
 
virtual void RefAdded (RefMakerHandle rm)
 Called after a reference is made to a target.
 
virtual void RefAddedUndoRedo (RefMakerHandle rm)
 Called after a reference is made to a target because of undo or redo.
 
 __declspec (deprecated) virtual void RefDeleted() final
 
virtual void RefDeleted (ReferenceMaker *oldOwner)
 Called after a reference to this is deleted.
 
 __declspec (deprecated) virtual void RefDeletedUndoRedo() final
 
virtual void RefDeletedUndoRedo (RefMakerHandle oldOwner)
 Called after a reference to this is deleted because of undo or redo.
 
CoreExport RefResult DeleteAllRefsToMe () override
 Deletes all references to this ReferenceTarget.
 
CoreExport RefResult TransferReferences (RefTargetHandle oldTarget, BOOL delOld=FALSE)
 Transfers all the references from oldTarget to this.
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network.
 
virtual CoreExport RefTargetHandle Clone (RemapDir &remap)
 This method is used by 3ds Max to clone an object.
 
virtual CoreExport void BaseClone (ReferenceTarget *from, ReferenceTarget *to, RemapDir &remap)
 This method copies base class data from an object to its clone.
 
CoreExport RefResult NotifyDependents (const Interval &changeInt, PartID partID, RefMessage message, SClass_ID sclass=NOTIFY_ALL, BOOL propagate=TRUE, RefTargetHandle hTarg=nullptr, NotifyDependentsOption notifyDependentsOption=REFNOTIFY_ALLOW_OPTIMIZATIONS) override
 Notify all dependent RefMakers concerned with the message.
 
void FlagDependents (TimeValue t, PartID which=PART_PUT_IN_FG)
 This sends the REFMSG_FLAGDEPENDENTS message up the pipeline.
 
virtual void NotifyForeground (TimeValue t)
 This method is called to flag dependents into the FG.
 
virtual void NotifyTarget (int message, ReferenceMaker *hMaker)
 Sends messages to ReferenceTargets.
 
CoreExport voidGetInterface (ULONG id) override
 Inherited from Animatable.
 
CoreExport BaseInterfaceGetInterface (Interface_ID id) override
 Inherited from Animatable.
 
CoreExport ReferenceTarget ()
 Constructor.
 
virtual CoreExport RefResult AutoDelete ()
 Deletes the object when it has no more real dependents.
 
CoreExport RefResult MaybeAutoDelete ()
 Deletes the object when it has no more real dependents.
 
- Public Member Functions inherited from ReferenceMaker
void GetClassName (MSTR &s, bool localized=true) const override
 Retrieves the name of the plugin class.
 
CoreExport SClass_ID SuperClassID () override
 Retrieves a constant representing the type of the plugin.
 
CoreExport RefResult ReplaceReference (int which, RefTargetHandle newtarg, BOOL delOld=TRUE)
 Used when cloning reference makers.
 
CoreExport RefResult DeleteAllRefsFromMe ()
 Deletes all references from this ReferenceMaker.
 
CoreExport RefResult DeleteAllRefs ()
 Deletes all references both to and from this item.
 
CoreExport RefResult DeleteReference (int i)
 Deletes the specified reference.
 
virtual BOOL CanTransferReference (int i)
 Tells whether this reference can be transfered.
 
CoreExport ReferenceSaveManagerGetReferenceSaveManager ()
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport IOResult Save (ISave *isave)
 Called for saving data.
 
virtual CoreExport IOResult Save (ISave *isave, ChannelMask)
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual CoreExport IOResult Load (ILoad *iload)
 Called for loading data.
 
virtual CoreExport IOResult Load (ILoad *iload, ChannelMask)
 Access the ReferenceSaveManager of this ReferenceMaker.
 
virtual int RemapRefOnLoad (int iref)
 Used to load old files with references.
 
virtual CoreExport void RescaleWorldUnits (float f)
 Rescale size of all world units in reference hierarchy.
 
CoreExport void EnumAuxFiles (AssetEnumCallback &assetEnum, DWORD flags) override
 Enumerate auxiliary files (e.g. bitmaps)
 
virtual CoreExport void SaveEnum (SaveEnumProc &sep, BOOL isNodeCall=0)
 The default save enumeration.
 
virtual CoreExport bool SpecifySaveReferences (ReferenceSaveManager &referenceSaveManager)
 Used to specify reference slot remapping during scene file save.
 
CoreExport int DoEnumDependents (DependentEnumProc *dep)
 Begins an enumeration that searches back in the dependency network.
 
CoreExport bool EnumRefHierarchy (RefEnumProc &proc, bool includeCustAttribs=true, bool includeIndirectRefs=true, bool includeNonPersistentRefs=true, bool preventDuplicatesViaFlag=true)
 This method provides a general purpose reference enumerator.
 
CoreExport int FindRef (RefTargetHandle rtarg)
 Get the index of the ReferenceTarget.
 
BOOL IsRefMaker () override
 Tells whether it is a ReferenceMaker.
 
virtual BOOL IsRealDependency (ReferenceTarget *rtarg)
 Returns whether this is a "real" (strong) dependency or not.
 
virtual BOOL ShouldPersistWeakRef (RefTargetHandle rtarg)
 Specifies whether a weak reference is to be persisted on a partial load or save.
 
CoreExport ReferenceMaker ()
 Constructor.
 
CoreExport void DeleteMe ()
 Deletes an instance of this class.
 
virtual CoreExport int NumRefs ()
 Returns the total number of references this ReferenceMaker can hold.
 
virtual CoreExport RefTargetHandle GetReference (int i)
 Returns the 'i-th' reference.
 
- Public Member Functions inherited from Animatable
virtual void FreeCaches ()
 
virtual int NumChildren ()
 
virtual AnimatableChildAnim (int i)
 
virtual CoreExport MSTR NodeName ()
 
virtual void EditTrack ()
 
virtual CoreExport BOOL SubAnimSetKeyBufferPresent (int subNum)
 returns true if the sub-anim has a "Set Key" buffer present
 
virtual BOOL SetKeyBufferPresent ()
 returns true if there is a "Set Key" buffer present
 
virtual CoreExport void SubAnimCommitSetKeyBuffer (TimeValue t, int subNum)
 Commit any "Set Key" buffers on the given sub-anim.
 
virtual void CommitSetKeyBuffer (TimeValue t)
 Commit any "Set Key" buffers.
 
virtual CoreExport void SubAnimRevertSetKeyBuffer (int subNum)
 Revert any "Set Key" buffers on the given sub-anim.
 
virtual void RevertSetKeyBuffer ()
 Revert any "Set Key" buffers.
 
virtual LRESULT CALLBACK TrackViewWinProc (HWND hwnd, UINT message, WPARAM wParam, LPARAM lParam)
 This function is obsolete.
 
virtual BOOL IsRefMaker ()
 Tells whether it is a ReferenceMaker.
 
virtual bool IsParamBlockDesc2Used (ParamBlockDesc2 *desc)
 Returns true if the passed description is being used.
 
virtual bool GetMacroRecorderName (bool used_as_rhs_value, MSTR &objectSpecifiedName)
 This method is called to access the object specified name to use for the Maxscript macrorecorder.
 
CoreExport Animatable ()
 Constructor.
 
virtual CoreExport void DeleteThis ()
 Deletes an instance of this class.
 
MSTR ClassName (bool localized=true) const
 Returns the name of the plugin class.
 
virtual CoreExport Class_ID ClassID ()
 Retrieves a constant that uniquely identifies the plugin class.
 
virtual void BeginEditParams (IObjParam *ip, ULONG flags, Animatable *prev=NULL)
 
virtual void EndEditParams (IObjParam *ip, ULONG flags, Animatable *next=NULL)
 
virtual CoreExport void ReleaseInterface (ULONG id, void *i)
 
virtual CoreExport int SetProperty (ULONG id, void *data)
 
virtual CoreExport voidGetProperty (ULONG id)
 
CoreExport void AppendProperty (AnimProperty *prop)
 A function to directly add arbitrary properties to this object developers should ensure that the properties ID does not conflict with any Max-specific IDs.
 
CoreExport AnimPropertyFindProperty (DWORD id)
 Find any property.
 
CoreExport void AddAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid, DWORD len, void *data)
 Adds application/plugin specific (custom) data to an Animatable.
 
CoreExport AppDataChunkGetAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Retrieves the application/plugin specific (custom) data stored with an Animatable.
 
CoreExport BOOL RemoveAppDataChunk (const Class_ID &cid, SClass_ID sid, DWORD sbid)
 Deletes the application/plugin specific (custom) data stored with an Animatable.
 
CoreExport void ClearAllAppData ()
 Deletes all application/plugin specific (custom) data stored with an Animatable.
 
virtual int NumSubs ()
 
virtual AnimatableSubAnim (int i)
 
 __declspec (deprecated) 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.
 
virtual ParamDimensionGetParamDimension (int i)
 
virtual BOOL SelectSubAnim (int subNum)
 
virtual BOOL BypassTreeView ()
 
virtual BOOL BypassTrackBar ()
 
virtual BOOL BypassPropertyLevel ()
 
virtual BOOL InvisibleProperty ()
 
virtual int NumKeys ()
 
virtual TimeValue GetKeyTime (int index)
 
virtual int GetKeyIndex (TimeValue t)
 
virtual BOOL GetNextKeyTime (TimeValue t, DWORD flags, TimeValue &nt)
 
virtual void CopyKeysFromTime (TimeValue src, TimeValue dst, DWORD flags)
 
virtual void DeleteKeyAtTime (TimeValue t)
 
virtual BOOL IsKeyAtTime (TimeValue t, DWORD flags)
 
virtual int GetKeyTimes (Tab< TimeValue > &times, Interval range, DWORD flags)
 
virtual int GetKeySelState (BitArray &sel, Interval range, DWORD flags)
 
CoreExport void OpenTreeEntry (int type, DWORD tv)
 
CoreExport void CloseTreeEntry (int type, DWORD tv)
 
CoreExport int IsTreeEntryOpen (int type, DWORD tv)
 
CoreExport BOOL GetSelInTrackView (DWORD tv)
 
CoreExport void SetSelInTrackView (DWORD tv, BOOL sel)
 
CoreExport BOOL InTrackViewSelSet (int which)
 
CoreExport void SetTrackViewSelSet (int which, BOOL inOut)
 
virtual BOOL AssignController (Animatable *control, int subAnim)
 
virtual BOOL CanAssignController (int subAnim)
 Return true if we can reassign the subanim specified.
 
virtual BOOL CanMakeUnique ()
 
CoreExport int EnumAnimTree (AnimEnum *animEnum, Animatable *client, int subNum)
 
virtual int RenderBegin (TimeValue t, ULONG flags=0)
 
virtual int RenderEnd (TimeValue t)
 
virtual CoreExport Interval GetTimeRange (DWORD flags)
 
virtual void EditTimeRange (Interval range, DWORD flags)
 
virtual void DeleteTime (Interval iv, DWORD flags)
 
virtual void ReverseTime (Interval iv, DWORD flags)
 
virtual void ScaleTime (Interval iv, float s)
 
virtual void InsertTime (TimeValue ins, TimeValue amount)
 
virtual BOOL SupportTimeOperations ()
 
virtual CoreExport void MapKeys (TimeMap *map, DWORD flags)
 
virtual void DeleteKeys (DWORD flags)
 
virtual void DeleteKeyByIndex (int index)
 
virtual void SelectKeys (TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubKeys (int subNum, TrackHitTab &sel, DWORD flags)
 
virtual void SelectSubCurve (int subNum, BOOL sel)
 
virtual void SelectKeyByIndex (int i, BOOL sel)
 
virtual BOOL IsKeySelected (int i)
 
virtual void FlagKey (TrackHitRecord hit)
 
virtual int GetFlagKeyIndex ()
 
virtual int NumSelKeys ()
 
virtual void CloneSelectedKeys (BOOL offset=FALSE)
 
virtual void AddNewKey (TimeValue t, DWORD flags)
 
virtual void MoveKeys (ParamDimensionBase *dim, float delta, DWORD flags)
 
virtual void ScaleKeyValues (ParamDimensionBase *dim, float origin, float scale, DWORD flags)
 
virtual void SelectCurve (BOOL sel)
 
virtual BOOL IsCurveSelected ()
 Returns TRUE if the function curve is selected; otherwise returns FALSE.
 
virtual BOOL IsSubCurveSelected (int subNum)
 Returns the selected state of the sub-curve whose index is passed.
 
virtual int GetSelKeyCoords (TimeValue &t, float &val, DWORD flags)
 
virtual void SetSelKeyCoords (TimeValue t, float val, DWORD flags)
 
virtual int SetSelKeyCoordsExpr (ParamDimension *dim, const MCHAR *timeExpr, const MCHAR *valExpr, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, int dx, int dy, DWORD flags)
 
virtual void AdjustTangents (TrackHitRecord hit, ParamDimensionBase *dim, float angle, float length, DWORD flags)
 
virtual CoreExport BOOL IsAnimated ()
 
virtual BOOL CanCopyTrack (Interval iv, DWORD flags)
 
virtual BOOL CanPasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopyTrack (Interval iv, DWORD flags)
 
virtual void PasteTrack (TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual BOOL CanCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual BOOL CanPasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual TrackClipObjectCopySubTrack (int subNum, Interval iv, DWORD flags)
 
virtual void PasteSubTrack (int subNum, TrackClipObject *cobj, Interval iv, DWORD flags)
 
virtual int GetTrackVSpace (int lineHeight)
 
virtual int HitTestTrack (TrackHitTab &hits, Rect &rcHit, Rect &rcTrack, float zoom, int scroll, DWORD flags)
 
virtual int PaintTrack (ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintSubTrack (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcTrack, Rect &rcPaint, float zoom, int scroll, DWORD flags)
 
virtual int PaintFCurves (ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestFCurves (ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int PaintSubFCurves (int subNum, ParamDimensionBase *dim, HDC hdc, Rect &rcGraph, Rect &rcPaint, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual int HitTestSubFCurves (int subNum, ParamDimensionBase *dim, TrackHitTab &hits, Rect &rcHit, Rect &rcGraph, float tzoom, int tscroll, float vzoom, int vscroll, DWORD flags)
 
virtual void EditTrackParams (TimeValue t, ParamDimensionBase *dim, const MCHAR *pname, HWND hParent, IObjParam *ip, DWORD flags)
 
virtual int TrackParamsType ()
 
virtual int GetFCurveExtents (ParamDimensionBase *dim, float &min, float &max, DWORD flags)
 This method is called to calculate the largest and smallest values of the anim.
 
CoreExport void AddNoteTrack (NoteTrack *note)
 
CoreExport void DeleteNoteTrack (NoteTrack *note, BOOL delNote=TRUE)
 
CoreExport BOOL HasNoteTracks ()
 
CoreExport int NumNoteTracks ()
 
CoreExport NoteTrackGetNoteTrack (int i)
 
virtual void FreeAllBitmaps ()
 
virtual void GetSystemNodes (INodeTab &nodes, SysNodeContext Context)
 
virtual BOOL IsSubClassOf (Class_ID classID)
 returns true if the animatable has sub-classed off the given class
 
virtual CoreExport void MouseCycleCompleted (TimeValue t)
 
virtual CoreExport void MouseCycleStarted (TimeValue t)
 
virtual int NumParamBlocks ()
 
virtual IParamBlock2GetParamBlockByID (short id)
 
CoreExport bool SvSaveData (ISave *isave, USHORT id)
 
CoreExport bool SvLoadData (ILoad *iLoad)
 
CoreExport DWORD SvGetRefIndex ()
 
CoreExport void SvSetRefIndex (DWORD i)
 
CoreExport bool SvDeleteRefIndex ()
 
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...
 
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"...
 
virtual CoreExport bool SvCanDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Returns true if this object can respond to the SvDetachRel(...) method...
 
virtual CoreExport bool SvDetachRel (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Detach this relationship.
 
virtual CoreExport bool SvHandleRelDoubleClick (IGraphObjectManager *gom, IGraphNode *gNodeTarget, int id, IGraphNode *gNodeMaker)
 Called when this relationship is double-clicked in the schematic view...
 
CoreExport ICustAttribContainerGetCustAttribContainer ()
 This method returns a pointer to the custom attributes container interface class.
 
CoreExport void AllocCustAttribContainer ()
 This method allocates space for a custom attributes container.
 
CoreExport void DeleteCustAttribContainer ()
 This method deletes space used by a custom attributes container.
 
void SetAFlag (DWORD mask)
 
void ClearAFlag (DWORD mask)
 Clears one or more bits in the Animatable flags.
 
bool TestAFlag (DWORD mask) const
 Tests one or more bits in the Animatable flags.
 
void SetAFlagEx (DWORD mask)
 Sets one or more bits in the Animatable extended flags.
 
void ClearAFlagEx (DWORD mask)
 Clears one or more bits in the Animatable extended flags.
 
bool TestAFlagEx (DWORD mask) const
 Tests one or more bits in the Animatable extended flags.
 
CoreExport bool TestFlagBit (int index)
 Tests the specified flag bit.
 
CoreExport void SetFlagBit (int index, bool newValue=true)
 Sets the specified flag bit.
 
CoreExport void ClearFlagBit (int index)
 Clears the specified flag bit.
 
- Public Member Functions inherited from InterfaceServer
virtual UtilExport ~InterfaceServer ()
 Destructor.
 
virtual UtilExport BaseInterfaceGetInterface (Interface_ID id)
 
template<class InterfaceType >
InterfaceType * GetTypedInterface ()
 

Additional Inherited Members

- Public Types inherited from LightscapeLight
enum  LightTypes {
  TYPE_BASE = 532 , TARGET_POINT_TYPE = TYPE_BASE + 0 , POINT_TYPE = TYPE_BASE + 1 , TARGET_LINEAR_TYPE = TYPE_BASE + 2 ,
  LINEAR_TYPE = TYPE_BASE + 3 , TARGET_AREA_TYPE = TYPE_BASE + 4 , AREA_TYPE = TYPE_BASE + 5 , TARGET_DISC_TYPE = TYPE_BASE + 6 ,
  DISC_TYPE = TYPE_BASE + 7 , TARGET_SPHERE_TYPE = TYPE_BASE + 8 , SPHERE_TYPE = TYPE_BASE + 9 , TARGET_CYLINDER_TYPE = TYPE_BASE + 10 ,
  CYLINDER_TYPE = TYPE_BASE + 11 , LAST_TYPE = CYLINDER_TYPE
}
 Types for the lights. More...
 
enum  DistTypes {
  ISOTROPIC_DIST = 0 , SPOTLIGHT_DIST = 1 , DIFFUSE_DIST = 2 , WEB_DIST = 3 ,
  LAST_DIST = WEB_DIST
}
 Types for the distributions. More...
 
enum  ReferenceIDs {
  REF_PARAMS = 0 , REF_SHADOW_PARAMS = 1 , REF_SPOT_PARAMS = 2 , REF_WEB_PARAMS = 3 ,
  REF_SHADOWGEN = 4 , REF_EXT_PARAMS = 5 , LAST_REF = REF_EXT_PARAMS
}
 IDs for the references kept by this object. More...
 
enum  ParameterBlockID {
  PB_GENERAL = 0 , PB_SHADOW = 1 , PB_SPOT = 2 , PB_WEB = 3 ,
  PB_EXT = 4 , LAST_PB = PB_EXT
}
 IDs for the parameters blocks for Lightscape lights. More...
 
enum  ParameterIDs {
  PB_DIST_TYPE = 1 , PB_USE_LIGHT = 2 , PB_CAST_SHADOWS = 3 , PB_LIGHT_COLOR = 4 ,
  PB_FILTER_COLOR = 5 , PB_INTENSITY = 6 , PB_KELVIN = 8 , PB_USE_KELVIN = 10 ,
  PB_INTENSITY_AT = 13 , PB_INTENSITY_TYPE = 14 , PB_FLUX = 15 , PB_ORIGINAL_INTENSITY = 16 ,
  PB_ORIGINAL_FLUX = 17 , PB_USE_DIMMER = 18 , PB_DIMMER = 19 , PB_COLORSHIFT_DIMMING = 20 ,
  PB_USE_FARATTENUATION = 21 , PB_SHOW_FARATTENUATION_GIZMO = 22 , PB_START_FARATTENUATION = 23 , PB_END_FARATTENUATION = 24 ,
  LAST_GEN_PB = PB_END_FARATTENUATION
}
 This enum is used to hold the General parameter IDs. More...
 
enum  ExtParamIDs {
  PB_CONTRAST = 0 , PB_DIFFSOFT = 1 , PB_PROJECTOR = 2 , PB_PROJECTOR_MAP = 3 ,
  PB_AFFECT_DIFFUSE = 4 , PB_AFFECT_SPECULAR = 5 , PB_AMBIENT_ONLY = 6 , PB_TDIST = 7 ,
  PB_LINELIGHT_LENGTH = 11 , PB_AREALIGHT_LENGTH = 11 , PB_AREALIGHT_WIDTH = 12 , PB_DISCLIGHT_RADIUS = 13 ,
  PB_SPHERELIGHT_RADIUS_OLD = 14 , PB_SPHERELIGHT_RADIUS = PB_DISCLIGHT_RADIUS , PB_CYLINDERLIGHT_RADIUS_OLD = 15 , PB_CYLINDERLIGHT_RADIUS = PB_DISCLIGHT_RADIUS ,
  PB_CYLINDERLIGHT_LENGTH_OLD = 16 , PB_CYLINDERLIGHT_LENGTH = PB_LINELIGHT_LENGTH , LAST_EXT_PB = PB_CYLINDERLIGHT_LENGTH_OLD
}
 This enum is used to hold the Extended parameter IDs. More...
 
enum  ShadowIDs {
  PB_ATMOS_SHAD = 0 , PB_ATMOS_OPACITY = 1 , PB_ATMOS_COLAMT = 2 , PB_SHADMULT = 3 ,
  PB_SHAD_COLMAP = 4 , PB_SHADCOLOR = 5 , PB_LIGHT_AFFECTS_SHADOW = 6 , PB_USE_GLOBAL_PARAMS = 7 ,
  PB_SHAD_PROJ_MAP = 8 , LAST_SHAD_PB = PB_SHAD_PROJ_MAP
}
 This enum is used to hold the Shadow parameter IDs. More...
 
enum  SpotlightIDs { PB_BEAM_ANGLE = 0 , PB_FIELD_ANGLE = 1 , PB_CONE_DISPLAY = 2 , LAST_SPOT_PB = PB_CONE_DISPLAY }
 This enum is used to hold the Spotlight parameter IDs. More...
 
enum  DistributionIDs {
  PB_WEB_FILE_NAME = 0 , PB_WEB_ROTATE_X = 1 , PB_WEB_ROTATE_Y = 2 , PB_WEB_ROTATE_Z = 3 ,
  LAST_WEB_PB = PB_WEB_ROTATE_Z
}
 This enum is used to hold the Photometric Web parameter IDs. More...
 
enum  IntensityType { LUMENS = 0 , CANDELAS = 1 , LUX_AT =2 }
 This enum is used to hold the intensity types. More...
 
enum  MaxShadowType { NO_SHADOW_GENERATOR = -1 , BITMAP_SHADOWS = 0 , RAYTRACE_SHADOWS = 1 , OTHER_SHADOWS = 0xffff }
 Shadow types for MAX. More...
 
enum  PresetLightColor {
  HALOGEN_WARM = 0 , HALOGEN_BASIC , HALOGEN_COOL , INCANDESCENT_FILAMENT_LAMP ,
  FLUORESCENT_WARM_WHITE , FLUORESCENT_COOL_WHITE , FLUORESCENT_WHITE , FLUORESCENT_DAYLIGHT ,
  FLUORESCENT_LITE_WHITE , HID_CERAMIC_METAL_HALIDE_WARM , HID_CERAMIC_METAL_HALIDE_COOL , HID_QUARTZ_METAL_HALIDE_WARM ,
  HID_QUARTZ_METAL_HALIDE , HID_QUARTZ_METAL_HALIDE_COOL , HID_MERCURY , HID_PHOSPHOR_MERCURY ,
  HID_XENON , HID_HIGH_PRESSURE_SODIUM , HID_LOW_PRESSURE_SODIUM , D65_ILLUMINANT_REFERENCE_WHITE ,
  D50_ILLUMINANT_REFERENCE_WHITE
}
 Preset light colors. More...
 
- Static Public Member Functions inherited from LightscapeLight
static AreaLightCustAttribGetAreaLightCustAttrib (CustAttrib *attrib)
 Returns the AreaLightCustAttrib interface for a custom attribute.
 
- Static Public Member Functions inherited from Animatable
static CoreExport BOOL IsDeleted (Animatable *anim)
 Debug method to determine whether an object has been deleted.
 
static CoreExport AnimHandle GetHandleByAnim (Animatable *anim)
 Get the unique handle for an Animatable object.
 
static CoreExport AnimatableGetAnimByHandle (AnimHandle handle)
 Get an Animatable object from its unique handle.
 
static CoreExport AnimHandle GetNextHandle ()
 Get the unique handle for the next Animatable object to be created.
 
static CoreExport void EnumerateAllAnimatables (EnumAnimList &enumProcObject)
 Enumerator to enumerate across all animatables.
 
static CoreExport bool RegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool UnRegisterAppDataLoadCallback (const Class_ID &cid, SClass_ID sid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool RegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Registers a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport bool UnRegisterAppDataLoadCallback (DWORD sbid, APPDATALOADPROC proc)
 Unregisters a callback proc that is called when an AppDataChunk is read from a scene file.
 
static CoreExport void ClearAFlagInAllAnimatables (DWORD mask)
 Clears one or more bits in the Animatable flags in all Animatables.
 
static CoreExport void ClearAFlagExInAllAnimatables (DWORD mask)
 Clears one or more bits in the Animatable extended flags in all Animatables.
 
static CoreExport int RequestFlagBit ()
 Requests an unique flag bit index.
 
static CoreExport void ReleaseFlagBit (int index)
 Releases the flag bit index.
 
static CoreExport void ClearFlagBitInAllAnimatables (int index)
 Clears the specified flag bit in all Animatables.
 
- Static Public Member Functions inherited from MaxHeapOperators
static UtilExport voidoperator new (size_t size)
 Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e)
 Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new (size_t size, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new (size_t size, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, int block_type, const char *filename, int line)
 New operator used to allocate arrays of objects.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport voidoperator new[] (size_t size, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown.
 
static UtilExport voidoperator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
 New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned.
 
static UtilExport void operator delete (void *ptr)
 Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete (void *ptr, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e)
 Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, int block_type, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
 Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen.
 
static UtilExport void operator delete[] (void *ptr, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport void operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
 Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown.
 
static UtilExport voidoperator new (size_t size, void *placement_ptr)
 Placement new operator.
 
static UtilExport void operator delete (void *ptr, void *placement_ptr)
 Placement delete operator.
 
static UtilExport voidaligned_malloc (size_t size, size_t alignment)
 Allocates memory on a specified alignment boundary.
 
static UtilExport voidaligned_realloc (void *ptr, size_t size, size_t alignment)
 Reallocates memory on a specified alignment boundary.
 
static UtilExport void aligned_free (void *ptr)
 Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.
 
- Static Public Attributes inherited from Animatable
static const AnimHandle kInvalidAnimHandle = 0
 
- Protected Member Functions inherited from ReferenceTarget
CoreExport int DoEnumDependentsImpl (DependentEnumProc *dep) override
 Method to perform an enumeration on a ReferenceTarget.
 
virtual CoreExport ~ReferenceTarget ()=0
 Destructor.
 
- Protected Member Functions inherited from ReferenceMaker
virtual CoreExport ~ReferenceMaker ()=0
 Destructor.
 
virtual CoreExport void SetReference (int i, RefTargetHandle rtarg)
 Stores a ReferenceTarget as its 'i-th' reference`.
 
void BlockEval ()
 Validates a given reference link between this reference maker and its reference target.
 
void UnblockEval ()
 Validates a given reference link between this reference maker and its reference target.
 
int Evaluating ()
 Validates a given reference link between this reference maker and its reference target.
 
CoreExport RefResult StdNotifyRefChanged (const Interval &changeInt, RefTargetHandle hTarget, PartID partID, RefMessage message, BOOL propagate, NotifyDependentsOption notifyDependentsOption)
 Validates a given reference link between this reference maker and its reference target.
 
- Protected Member Functions inherited from Animatable
virtual CoreExport ~Animatable ()=0
 Destructor.
 
- Protected Member Functions inherited from Noncopyable
 Noncopyable ()
 
 ~Noncopyable ()
 
- Protected Attributes inherited from BaseObject
MaxSDK::Graphics::RenderItemHandleArray mRenderItemHandles
 
- Protected Attributes inherited from Animatable
DWORD aflag
 
AnimPropertyList aprops
 

Detailed Description

Extension to Photometric light This interface extends class LightscapeLight with new functionality in 3ds Max 2016.

Member Function Documentation

◆ BakeWebDistribution()

virtual bool BakeWebDistribution ( MaxSDK::Array< float > &  bakedDistribution,
size_t bakedWidth,
size_t bakedHeight 
)
pure virtual

Bakes a web distribution into a spherical map.

Bakes the web (IES) distribution into a spherical map of floating-point intensities which are to be multiplied against the light's global intensity value. The resulting texture has the x coordinates covering the horizontal angles, from -PI to PI radians, and the y coordinates covering the vertical angles, from 0 to PI radians, 0 being +Z and PI being -Z. The rotation of the web distribution, returned by GetWebRotateX() and friends, is baked in the result. The resolution of the baked texture is determined internally and is based on the resolution of the original data from the web distribution (.ies) file.

Parameters
[out]bakedDistribution- An array of floating-point intensities which is allocated and filled by the method. The array represents a spherical texture map. The size of the array is: bakedWidth * bakedHeight.
[out]bakedWidth- The width of the baked spherical texture map.
[out]bakedHeight- The height of the baked spherical texture map.
Returns
false if and only the method is invalid on this light (i.e. if the light doesn't use a web distribution). If the light uses a web distribution but the file could not be loaded, this method returns true with an empty baked map (the resolution is zero).