FbxLight Class Reference
FbxLight Class Reference
This reference page is linked to from the following overview topics: #include <fbxlight.h>
Class Description
This node attribute contains methods for accessing the properties of a light.
- Examples:
Definition at line 27 of file fbxlight.h.
Inheritance diagram for FbxLight:
Light Properties | |
| enum | EType { ePoint, eDirectional, eSpot, eArea, eVolume } |
| Light types. More... | |
| enum | EDecayType { eNone, eLinear, eQuadratic, eCubic } |
| Decay types. More... | |
| enum | EAreaLightShape { eRectangle, eSphere } |
| Supported area light types. More... | |
| void | SetShadowTexture (FbxTexture *pTexture) |
| Set the shadow texture for the light. More... | |
| FbxTexture * | GetShadowTexture () const |
| Get the light state. More... | |
Properties | |
| FbxPropertyT< EType > | LightType |
| This property handles the light type. More... | |
| FbxPropertyT< FbxBool > | CastLight |
| This property handles the cast light on object flag. More... | |
| FbxPropertyT< FbxBool > | DrawVolumetricLight |
| This property handles the draw volumetric light flag. More... | |
| FbxPropertyT< FbxBool > | DrawGroundProjection |
| This property handles the draw ground projection flag. More... | |
| FbxPropertyT< FbxBool > | DrawFrontFacingVolumetricLight |
| This property handles the draw facing volumetric projection flag. More... | |
| FbxPropertyT< FbxDouble3 > | Color |
| This property handles the light color. More... | |
| FbxPropertyT< FbxDouble > | Intensity |
| This property handles the light intensity. More... | |
| FbxPropertyT< FbxDouble > | InnerAngle |
| This property handles the light inner cone angle (in degrees). More... | |
| FbxPropertyT< FbxDouble > | OuterAngle |
| This property handles the light outer cone angle (in degrees). More... | |
| FbxPropertyT< FbxDouble > | Fog |
| This property handles the light fog intensity. More... | |
| FbxPropertyT< EDecayType > | DecayType |
| This property handles the decay type. More... | |
| FbxPropertyT< FbxDouble > | DecayStart |
| This property handles the decay start distance. More... | |
| FbxPropertyT< FbxString > | FileName |
| This property handles the gobo file name. More... | |
| FbxPropertyT< FbxBool > | EnableNearAttenuation |
| This property handles the enable near attenuation flag. More... | |
| FbxPropertyT< FbxDouble > | NearAttenuationStart |
| This property handles the near attenuation start distance. More... | |
| FbxPropertyT< FbxDouble > | NearAttenuationEnd |
| This property handles the near end attenuation. More... | |
| FbxPropertyT< FbxBool > | EnableFarAttenuation |
| This property handles the enable far attenuation flag. More... | |
| FbxPropertyT< FbxDouble > | FarAttenuationStart |
| This property handles the far attenuation start distance. More... | |
| FbxPropertyT< FbxDouble > | FarAttenuationEnd |
| This property handles the attenuation end distance. More... | |
| FbxPropertyT< FbxBool > | CastShadows |
| This property handles the cast shadow flag. More... | |
| FbxPropertyT< FbxDouble3 > | ShadowColor |
| This property handles the shadow color. More... | |
| FbxPropertyT< EAreaLightShape > | AreaLightShape |
| This property handles type when LightType is eArea. More... | |
| FbxPropertyT< FbxFloat > | LeftBarnDoor |
| This property handles the left barn door angle. More... | |
| FbxPropertyT< FbxFloat > | RightBarnDoor |
| This property handles the right barn door angle. More... | |
| FbxPropertyT< FbxFloat > | TopBarnDoor |
| This property handles the top barn door angle. More... | |
| FbxPropertyT< FbxFloat > | BottomBarnDoor |
| This property handles the bottom barn door angle. More... | |
| FbxPropertyT< FbxBool > | EnableBarnDoor |
| This property handles active status of barn doors. More... | |
Additional Inherited Members | |
| Public Types inherited from FbxNodeAttribute | |
| enum | EType { eUnknown, eNull, eMarker, eSkeleton, eMesh, eNurbs, ePatch, eCamera, eCameraStereo, eCameraSwitcher, eLight, eOpticalReference, eOpticalMarker, eNurbsCurve, eTrimNurbsSurface, eBoundary, eNurbsSurface, eShape, eLODGroup, eSubDiv, eCachedEffect, eLine } |
| Node attribute types. More... | |
| Public Types inherited from FbxObject | |
| enum | EObjectFlag { eNone = 0, eInitialized = 1 << 0, eSystem = 1 << 1, eSavable = 1 << 2, eSelected = 1 << 3, eHidden = 1 << 4, eContentLoaded = 1 << 5, eDontLocalize = 1 << 6, eCopyCalledByClone = 1 << 16 } |
| Flags available to control objects. More... | |
| enum | ECloneType { eDeepClone, eReferenceClone } |
| Types of clones that can be created for FbxObject. More... | |
| Public Member Functions inherited from FbxNodeAttribute | |
| virtual FbxNodeAttribute::EType | GetAttributeType () const |
| Return the type of node attribute. More... | |
| int | GetNodeCount () const |
| Return the node count using this attribute. More... | |
| FbxNode * | GetNode (int pIndex=0) const |
| Return the node this attribute is set to. More... | |
| Public Member Functions inherited from FbxObject | |
| virtual void | Compact () |
| Compact the memory used by this object. More... | |
| FBX_DEPRECATED bool | Is (const FbxClassId &pClassId) const |
| Test if this class is a hierarchical children of the specified class type. More... | |
| template<class T > | |
| bool | Is () const |
| Templated test if this class is a hierarchical children of the specified class type. More... | |
| FbxManager * | GetFbxManager () const |
| Retrieve the FbxManager this object belongs to. More... | |
| FbxDocument * | GetDocument () const |
| Returns a const pointer to the document that contains this object. More... | |
| FbxDocument * | GetRootDocument () const |
| Returns a const pointer to the root document that contains this object. More... | |
| FbxScene * | GetScene () const |
| Returns a const pointer to the scene that contains this object. More... | |
| void | Destroy (bool pRecursive=false) |
| Unregister and delete this object from memory. More... | |
| void | ResetProperties () |
| Reset all the properties of this object to their default values. More... | |
| virtual bool | GetSelected () |
| Returns if this object is currently in a selected state. More... | |
| virtual void | SetSelected (bool pSelected) |
| Sets whether this object is currently selected. More... | |
| void | SetUserDataPtr (const FbxUInt64 &pUserID, void *pUserData) |
| Sets the data pointer for an user data record whose ID is pUserID. More... | |
| void * | GetUserDataPtr (const FbxUInt64 &pUserID) const |
| Returns the data pointer of an user data record whose ID is pUserID. More... | |
| void | SetUserDataPtr (void *pUserData) |
| Sets the data pointer for the user data record whose ID is the object ID. More... | |
| void * | GetUserDataPtr () const |
| Returns the data pointer of the user data record whose ID is the object ID. More... | |
| bool | ConnectSrcObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone) |
| Connects this object to a source object. More... | |
| bool | IsConnectedSrcObject (const FbxObject *pObject) const |
| Judges whether this object connects with the source object. More... | |
| bool | DisconnectSrcObject (FbxObject *pObject) |
| Disconnects this object from a source object. More... | |
| bool | DisconnectAllSrcObject () |
| Disconnects this object from all source objects. More... | |
| bool | DisconnectAllSrcObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all source objects that satisfy a given criteria. More... | |
| FBX_DEPRECATED bool | DisconnectAllSrcObject (FbxClassId pClassId) |
| Disconnects this object from all source objects of a specific class type. More... | |
| int | GetSrcObjectCount () const |
| Returns the number of source objects with which this object connects. More... | |
| int | GetSrcObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of source objects that satisfy the given criteria with which this object connects. More... | |
| FBX_DEPRECATED int | GetSrcObjectCount (FbxClassId pClassId) const |
| Returns the number of source objects of the specific class type with which this object connects. More... | |
| FbxObject * | GetSrcObject (int pIndex=0) const |
| Returns the source object with which this object connects at the specified index. More... | |
| FbxObject * | GetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the source object that satisfies the criteria at the specified index with which this object connects. More... | |
| FBX_DEPRECATED FbxObject * | GetSrcObject (FbxClassId pClassId, int pIndex=0) const |
| Returns the source object of the specified class type at the specified index with which this object connects. More... | |
| FbxObject * | FindSrcObject (const char *pName, int pStartIndex=0) const |
| Searches the source object with the specified name, starting at the specified index. More... | |
| FbxObject * | FindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the source object with the specified name which satisfies the given criteria, starting at the specified index. More... | |
| FBX_DEPRECATED FbxObject * | FindSrcObject (FbxClassId pClassId, const char *pName, int pStartIndex=0) const |
| Searches the source object with the specified name which is also the specified class type, starting at the specified index. More... | |
| template<class T > | |
| bool | DisconnectAllSrcObject () |
| Disconnects this object from all source objects of the specified class type. More... | |
| template<class T > | |
| bool | DisconnectAllSrcObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all source objects that are of the specified class type and that satisfy the given criteria. More... | |
| template<class T > | |
| int | GetSrcObjectCount () const |
| Returns the number of source objects of a specific class type with which this object connects. More... | |
| template<class T > | |
| int | GetSrcObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of source objects with which this object connects that are the specified class type and that satisfy the given criteria. More... | |
| template<class T > | |
| T * | GetSrcObject (int pIndex=0) const |
| Returns the source object of the specified class type at the specified index. More... | |
| template<class T > | |
| T * | GetSrcObject (const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the source object that is the specified class type and that satisfies the given criteria at the specified index. More... | |
| template<class T > | |
| T * | FindSrcObject (const char *pName, int pStartIndex=0) const |
| Searches the source object with the specified name that is the specified class type, starting at the specified index. More... | |
| template<class T > | |
| T * | FindSrcObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the source object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index. More... | |
| bool | ConnectDstObject (FbxObject *pObject, FbxConnection::EType pType=FbxConnection::eNone) |
| Connects this object to one destination object. More... | |
| bool | IsConnectedDstObject (const FbxObject *pObject) const |
| Judges whether this object connects with the destination object. More... | |
| bool | DisconnectDstObject (FbxObject *pObject) |
| Disconnects this object from the destination object. More... | |
| bool | DisconnectAllDstObject () |
| Disconnects this object from all destination objects. More... | |
| bool | DisconnectAllDstObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all destination objects that satisfy given criteria. More... | |
| FBX_DEPRECATED bool | DisconnectAllDstObject (FbxClassId pClassId) |
| Disconnects this object from all destination objects of the specified class type. More... | |
| int | GetDstObjectCount () const |
| Returns the number of destination objects with which this object connects. More... | |
| int | GetDstObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of destination objects with which this object connects that satisfy the given criteria. More... | |
| FBX_DEPRECATED int | GetDstObjectCount (FbxClassId pClassId) const |
| Returns the number of destination objects of the specified class type with which this object connects. More... | |
| FbxObject * | GetDstObject (int pIndex=0) const |
| Returns the destination object at the specified index with which this object connects. More... | |
| FbxObject * | GetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the destination object with which this object connects that satisfies the given criteria at the specified index. More... | |
| FBX_DEPRECATED FbxObject * | GetDstObject (FbxClassId pClassId, int pIndex=0) const |
| Returns the destination object of the specified class type with which this object connects at the specified index. More... | |
| FbxObject * | FindDstObject (const char *pName, int pStartIndex=0) const |
| Searches the destination object with the specified name, starting at the specified index. More... | |
| FbxObject * | FindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the specified name which satisfies the given criteria, starting at the specified index. More... | |
| FBX_DEPRECATED FbxObject * | FindDstObject (FbxClassId pClassId, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the specified name which is the specified class type, starting at the specified index. More... | |
| template<class T > | |
| bool | DisconnectAllDstObject () |
| Disconnects this object from all destination objects of the specified class type. More... | |
| template<class T > | |
| bool | DisconnectAllDstObject (const FbxCriteria &pCriteria) |
| Disconnects this object from all destination objects that are the specified class type and that satisfy the given criteria. More... | |
| template<class T > | |
| int | GetDstObjectCount () const |
| Returns the number of destination objects of the specified class type with which this object connects. More... | |
| template<class T > | |
| int | GetDstObjectCount (const FbxCriteria &pCriteria) const |
| Returns the number of destination objects with which this object connects that are the specified class type and that satisfy the given criteria. More... | |
| template<class T > | |
| T * | GetDstObject (int pIndex=0) const |
| Returns the destination object with which this object connects that is the specified class type at the specified index. More... | |
| template<class T > | |
| T * | GetDstObject (const FbxCriteria &pCriteria, int pIndex=0) const |
| Returns the destination object with which this object connects that is the specified class type and that satisfies the given criteria at the specified index. More... | |
| template<class T > | |
| T * | FindDstObject (const char *pName, int pStartIndex=0) const |
| Searches the destination object with the specified name which is of the specified class type, starting at the specified index. More... | |
| template<class T > | |
| T * | FindDstObject (const FbxCriteria &pCriteria, const char *pName, int pStartIndex=0) const |
| Searches the destination object with the specified name that is the specified class type and that satisfies the given criteria, starting at the specified index. More... | |
| FbxProperty | GetFirstProperty () const |
| Returns the first property of this object. More... | |
| FbxProperty | GetNextProperty (const FbxProperty &pProperty) const |
| Returns the next property of this object that follows the specified property. More... | |
| FbxProperty | FindProperty (const char *pName, bool pCaseSensitive=true) const |
| Searches a property by name. More... | |
| FbxProperty | FindProperty (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const |
| Searches a property by name and data type. More... | |
| FbxProperty | FindPropertyHierarchical (const char *pName, bool pCaseSensitive=true) const |
| Searches a property by full name. More... | |
| FbxProperty | FindPropertyHierarchical (const char *pName, const FbxDataType &pDataType, bool pCaseSensitive=true) const |
| Searches a property by full name and data type. More... | |
| FbxProperty | GetClassRootProperty () |
| Returns the class root property. More... | |
| bool | ConnectSrcProperty (const FbxProperty &pProperty) |
| Connects this object to a source property. More... | |
| bool | IsConnectedSrcProperty (const FbxProperty &pProperty) |
| Determines whether this object connects with the specified source property. More... | |
| bool | DisconnectSrcProperty (const FbxProperty &pProperty) |
| Disconnects this object from the specified source property. More... | |
| int | GetSrcPropertyCount () const |
| Returns the number of source properties with which this object connects. More... | |
| FbxProperty | GetSrcProperty (int pIndex=0) const |
| Returns the source property at the specified index with which this object connects. More... | |
| FbxProperty | FindSrcProperty (const char *pName, int pStartIndex=0) const |
| Searches a source property with which this object connects that has a specific name, starting at the specified index. More... | |
| bool | ConnectDstProperty (const FbxProperty &pProperty) |
| Connects this object to a destination property. More... | |
| bool | IsConnectedDstProperty (const FbxProperty &pProperty) |
| Determines if this object connects with the specified destination property. More... | |
| bool | DisconnectDstProperty (const FbxProperty &pProperty) |
| Disconnects this object from the specified destination property. More... | |
| int | GetDstPropertyCount () const |
| Returns the number of destination properties with which this object connects. More... | |
| FbxProperty | GetDstProperty (int pIndex=0) const |
| Returns the destination property at the specified index with which this object connects. More... | |
| FbxProperty | FindDstProperty (const char *pName, int pStartIndex=0) const |
| Searches a destination property with which this object connects that has a specific name, starting at the specified index. More... | |
| int | ContentUnload () |
| Unloads this object's content using the offload peripheral that is currently set in the document then flushes it from memory. More... | |
| int | ContentLoad () |
| Loads this object's content using the offload peripheral that is currently set in the document. More... | |
| bool | ContentIsLoaded () const |
| Judges if this object's content is loaded. More... | |
| void | ContentDecrementLockCount () |
| Decreases the content lock count of an object. More... | |
| void | ContentIncrementLockCount () |
| Increases the content lock count of an object. More... | |
| bool | ContentIsLocked () const |
| Judges if this object's content is locked. More... | |
| virtual bool | ContentWriteTo (FbxStream &pStream) const |
| Writes the content of the object to the given stream. More... | |
| virtual bool | ContentReadFrom (const FbxStream &pStream) |
| Reads the content of the object from the given stream. More... | |
| void | EmitMessage (FbxMessage *pMessage) const |
| Emits a message in all available message emitters in the document or SDK manager. More... | |
| virtual const char * | Localize (const char *pID, const char *pDefault=NULL) const |
| Localization helper function, it calls the implementation of FBX SDK manager. More... | |
| FbxLibrary * | GetParentLibrary () const |
| Returns a handle on the parent library of this object. More... | |
| bool | AddImplementation (FbxImplementation *pImplementation) |
| Adds an implementation. More... | |
| bool | RemoveImplementation (FbxImplementation *pImplementation) |
| Removes an implementation. More... | |
| bool | HasDefaultImplementation (void) const |
| Determines if this shading node has a default implementation. More... | |
| FbxImplementation * | GetDefaultImplementation (void) const |
| Returns the default implementation of this shading node. More... | |
| bool | SetDefaultImplementation (FbxImplementation *pImplementation) |
| Sets the default implementation of this shading node. More... | |
| int | GetImplementationCount (const FbxImplementationFilter *pCriteria=NULL) const |
| Returns the number of implementations that satisfy a given criteria. More... | |
| FbxImplementation * | GetImplementation (int pIndex, const FbxImplementationFilter *pCriteria=NULL) const |
| Returns the implementation at the specified index that satisfies the given criteria. More... | |
| virtual FbxString | GetUrl () const |
| Returns the URL of this object. More... | |
| virtual bool | SetUrl (char *pUrl) |
| Sets the URL of this object. More... | |
| void | SetRuntimeClassId (const FbxClassId &pClassId) |
| Set the run-time ClassId for this class. More... | |
| FbxClassId | GetRuntimeClassId () const |
| Retrieve the run-time ClassId for this object. More... | |
| bool | IsRuntime (const FbxClassId &pClassId) const |
| Test if this class is a hierarchical children of the specified class type. More... | |
| bool | IsRuntimePlug () const |
| Find out if the ClassId was registered during run-time rather than at compile time. More... | |
| void | SetObjectFlags (EObjectFlag pFlags, bool pValue) |
| Set the state of object flags. More... | |
| bool | GetObjectFlags (EObjectFlag pFlags) const |
| Get the state of object flags. More... | |
| void | SetAllObjectFlags (FbxUInt pFlags) |
| Override all object flags at once. More... | |
| FbxUInt | GetAllObjectFlags () const |
| Get all object flags at once. More... | |
| virtual FbxObject & | Copy (const FbxObject &pObject) |
| Copy an object content into this object. More... | |
| virtual FbxObject * | Clone (FbxObject::ECloneType pCloneType=eDeepClone, FbxObject *pContainer=NULL, void *pSet=NULL) const |
| Creates a clone of this object. More... | |
| bool | IsAReferenceTo () const |
| Checks if this object is a reference clone of another object. More... | |
| FbxObject * | GetReferenceTo () const |
| If this object is a reference clone, returns the original object (from which the clone originates). More... | |
| bool | IsReferencedBy () const |
| Checks if any objects are reference cloned from this object. More... | |
| int | GetReferencedByCount () const |
| Returns the number of objects that are reference clones of this object. More... | |
| FbxObject * | GetReferencedBy (int pIndex) const |
| Returns a reference clone of this object at the specified index. More... | |
| void | SetName (const char *pName) |
| Sets the name of this object. More... | |
| const char * | GetName () const |
| Returns the full name of this object. More... | |
| FbxString | GetNameWithoutNameSpacePrefix () const |
| Returns the name of the object without the namespace qualifier. More... | |
| FbxString | GetNameWithNameSpacePrefix () const |
| Returns the name of the object with the namespace qualifier. More... | |
| void | SetInitialName (const char *pName) |
| Sets the initial name of the object. More... | |
| const char * | GetInitialName () const |
| Returns the initial name of the object. More... | |
| FbxString | GetNameSpaceOnly () |
| Returns the namespace of the object. More... | |
| void | SetNameSpace (FbxString pNameSpace) |
| Sets the namespace of the object. More... | |
| FbxArray< FbxString * > | GetNameSpaceArray (char identifier) |
| Returns an array of all the namespaces for this object. More... | |
| FbxString | GetNameOnly () const |
| Returns only the name (no namespace or prefix) of the object. More... | |
| FbxString | GetNameSpacePrefix () const |
| Returns the namespace qualifier. More... | |
| const FbxUInt64 & | GetUniqueID () const |
| Returns the unique ID of this object. More... | |
| Public Member Functions inherited from FbxEmitter | |
| void | AddListener (FbxEventHandler &pHandler) |
| Add the specified event handler to current emitter list. More... | |
| void | RemoveListener (FbxEventHandler &pHandler) |
| Remove the specified event handler from current emitter list. More... | |
| template<typename EventType > | |
| void | Emit (const EventType &pEvent) const |
| Emit an event with the specified the event type. More... | |
| Static Public Member Functions inherited from FbxObject | |
| static FbxString | RemovePrefix (char *pName) |
| Removes the prefix of pName. More... | |
| static FbxString | StripPrefix (FbxString &lName) |
| Strips the prefix of pName. More... | |
| static FbxString | StripPrefix (const char *pName) |
| Strips the prefix of pName. More... | |
| Public Attributes inherited from FbxNodeAttribute | |
| FbxPropertyT< FbxDouble3 > | Color |
| This property handles the color. More... | |
| Public Attributes inherited from FbxObject | |
| FbxProperty | RootProperty |
| The root property that holds all children property for this object. More... | |
| Static Public Attributes inherited from FbxNodeAttribute | |
| static const char * | sColor |
| Property Names. More... | |
| static const FbxDouble3 | sDefaultColor |
| Property Default Values. More... | |
| Protected Member Functions inherited from FbxObject | |
| virtual void | Construct (const FbxObject *pFrom) |
| Optional constructor override, automatically called by default constructor. More... | |
| virtual void | ConstructProperties (bool pForceSet) |
| Optional property constructor override, automatically called by default constructor. More... | |
| virtual void | Destruct (bool pRecursive) |
| Optional destructor override, automatically called by default destructor. More... | |
| virtual void | ContentClear () |
| Clears this object's content from memory. More... | |
| virtual FbxPeripheral * | GetPeripheral () |
| Retrieves the peripheral of that object. More... | |
Member Enumeration Documentation
| enum EType |
Light types.
- ePoint
- eDirectional
- eSpot
- eArea
- eVolume
| Enumerator | |
|---|---|
| ePoint | |
| eDirectional | |
| eSpot | |
| eArea | |
| eVolume | |
Definition at line 43 of file fbxlight.h.
Definition: fbxlight.h:49
Definition: fbxlight.h:45
Definition: fbxlight.h:46
Definition: fbxlight.h:47
Definition: fbxlight.h:48
| enum EDecayType |
Decay types.
Used for setting the attenuation of the light.
- eNone No decay. The light's intensity will not diminish with distance.
- eLinear Linear decay. The light's intensity will diminish linearly with the distance from the light.
- eQuadratic Quadratic decay. The light's intensity will diminish with the squared distance from the light. This is the most physically accurate decay rate.
- eCubic Cubic decay. The light's intensity will diminish with the cubed distance from the light.
| Enumerator | |
|---|---|
| eNone | |
| eLinear | |
| eQuadratic | |
| eCubic | |
Definition at line 59 of file fbxlight.h.
Definition: fbxlight.h:62
Definition: fbxlight.h:64
Definition: fbxlight.h:63
Definition: fbxlight.h:61
| enum EAreaLightShape |
Supported area light types.
- eRectangle Rectangle (or often called a plane) area light type.
- eSphere Area light that illuminate all directions.
| Enumerator | |
|---|---|
| eRectangle | |
| eSphere | |
Definition at line 71 of file fbxlight.h.
Definition: fbxlight.h:73
Definition: fbxlight.h:74
Member Function Documentation
| void SetShadowTexture | ( | FbxTexture * | pTexture | ) |
Set the shadow texture for the light.
- Parameters
-
pTexture The texture cast by the light shadow.
| FbxTexture* GetShadowTexture | ( | ) | const |
Get the light state.
- Returns
- Pointer to the texture cast by the light shadow, or
NULLif the shadow texture has not been set.
Member Data Documentation
| FbxPropertyT<EType> LightType |
This property handles the light type.
Default value is ePoint
- Examples:
Definition at line 96 of file fbxlight.h.
| FbxPropertyT<FbxBool> CastLight |
This property handles the cast light on object flag.
Default value is true
- Examples:
Definition at line 102 of file fbxlight.h.
| FbxPropertyT<FbxBool> DrawVolumetricLight |
This property handles the draw volumetric light flag.
Default value is true
- Examples:
Definition at line 108 of file fbxlight.h.
| FbxPropertyT<FbxBool> DrawGroundProjection |
This property handles the draw ground projection flag.
Default value is true
- Examples:
Definition at line 114 of file fbxlight.h.
| FbxPropertyT<FbxBool> DrawFrontFacingVolumetricLight |
This property handles the draw facing volumetric projection flag.
Default value is false
- Examples:
Definition at line 120 of file fbxlight.h.
| FbxPropertyT<FbxDouble3> Color |
This property handles the light color.
Default value is (1.0, 1.0, 1.0)
- Examples:
Definition at line 126 of file fbxlight.h.
| FbxPropertyT<FbxDouble> Intensity |
This property handles the light intensity.
Default value is 100.0
- Examples:
Definition at line 132 of file fbxlight.h.
| FbxPropertyT<FbxDouble> InnerAngle |
This property handles the light inner cone angle (in degrees).
Also know as the HotSpot
Default value is 45.0
- Examples:
Definition at line 138 of file fbxlight.h.
| FbxPropertyT<FbxDouble> OuterAngle |
This property handles the light outer cone angle (in degrees).
Also known as the Falloff
Default value is 45.0
- Examples:
Definition at line 144 of file fbxlight.h.
| FbxPropertyT<FbxDouble> Fog |
This property handles the light fog intensity.
Default value is 50.0
- Examples:
Definition at line 150 of file fbxlight.h.
| FbxPropertyT<EDecayType> DecayType |
This property handles the decay type.
Default value is eNone
Definition at line 156 of file fbxlight.h.
| FbxPropertyT<FbxDouble> DecayStart |
This property handles the decay start distance.
Default value is 0.0
Definition at line 162 of file fbxlight.h.
| FbxPropertyT<FbxString> FileName |
This property handles the gobo file name.
Default value is ""
- Examples:
Definition at line 168 of file fbxlight.h.
| FbxPropertyT<FbxBool> EnableNearAttenuation |
This property handles the enable near attenuation flag.
Default value is false
Definition at line 174 of file fbxlight.h.
| FbxPropertyT<FbxDouble> NearAttenuationStart |
This property handles the near attenuation start distance.
Default value is 0.0
Definition at line 180 of file fbxlight.h.
| FbxPropertyT<FbxDouble> NearAttenuationEnd |
This property handles the near end attenuation.
Default value is 0.0
Definition at line 186 of file fbxlight.h.
| FbxPropertyT<FbxBool> EnableFarAttenuation |
This property handles the enable far attenuation flag.
Default value is false
Definition at line 192 of file fbxlight.h.
| FbxPropertyT<FbxDouble> FarAttenuationStart |
This property handles the far attenuation start distance.
Default value is 0.0
Definition at line 198 of file fbxlight.h.
| FbxPropertyT<FbxDouble> FarAttenuationEnd |
This property handles the attenuation end distance.
Default value is 0.0
Definition at line 204 of file fbxlight.h.
| FbxPropertyT<FbxBool> CastShadows |
This property handles the cast shadow flag.
Default value is false
Definition at line 210 of file fbxlight.h.
| FbxPropertyT<FbxDouble3> ShadowColor |
This property handles the shadow color.
Default value is (0.0, 0.0, 0.0)
Definition at line 216 of file fbxlight.h.
| FbxPropertyT<EAreaLightShape> AreaLightShape |
This property handles type when LightType is eArea.
Default value is eRectangle
Definition at line 222 of file fbxlight.h.
| FbxPropertyT<FbxFloat> LeftBarnDoor |
This property handles the left barn door angle.
Default value is 20.0
Definition at line 228 of file fbxlight.h.
| FbxPropertyT<FbxFloat> RightBarnDoor |
This property handles the right barn door angle.
Default value is 20.0
Definition at line 234 of file fbxlight.h.
| FbxPropertyT<FbxFloat> TopBarnDoor |
This property handles the top barn door angle.
Default value is 20.0
Definition at line 240 of file fbxlight.h.
| FbxPropertyT<FbxFloat> BottomBarnDoor |
This property handles the bottom barn door angle.
Default value is 20.0
Definition at line 246 of file fbxlight.h.
| FbxPropertyT<FbxBool> EnableBarnDoor |
This property handles active status of barn doors.
Default value is false
Definition at line 252 of file fbxlight.h.
The documentation for this class was generated from the following file:
- fbxsdk/scene/geometry/fbxlight.h