KFbxLight Class Reference

#include <kfbxlight.h>
Inheritance diagram for KFbxLight:
Inheritance graph
[legend]

List of all members.

Detailed Description

This node attribute contains methods for accessing the properties of a light.

Definition at line 55 of file kfbxlight.h.


Light Properties
enum   ELightType
  Light types. More...
enum   EDecayType
  Decay types. More...
void  SetShadowTexture (KFbxTexture *pTexture)
  Set the shadow texture for the light.
KFbxTexture *  GetShadowTexture () const
  Get the light state.

Light Property Names
static const char *  sLightType
static const char *  sCastLight
static const char *  sDrawVolumetricLight
static const char *  sDrawGroundProjection
static const char *  sDrawFrontFacingVolumetricLight
static const char *  sColor
  Property Names.
static const char *  sIntensity
static const char *  sHotSpot
static const char *  sConeAngle
static const char *  sFog
static const char *  sDecayType
static const char *  sDecayStart
static const char *  sFileName
static const char *  sEnableNearAttenuation
static const char *  sNearAttenuationStart
static const char *  sNearAttenuationEnd
static const char *  sEnableFarAttenuation
static const char *  sFarAttenuationStart
static const char *  sFarAttenuationEnd
static const char *  sCastShadows
static const char *  sShadowColor

Light Property Default Values
static const ELightType  sDefaultLightType
static const fbxBool1  sDefaultCastLight
static const fbxBool1  sDefaultDrawVolumetricLight
static const fbxBool1  sDefaultDrawGroundProjection
static const fbxBool1  sDefaultDrawFrontFacingVolumetricLight
static const fbxDouble3  sDefaultColor
  Property Default Values.
static const fbxDouble1  sDefaultIntensity
static const fbxDouble1  sDefaultHotSpot
static const fbxDouble1  sDefaultConeAngle
static const fbxDouble1  sDefaultFog
static const EDecayType  sDefaultDecayType
static const fbxDouble1  sDefaultDecayStart
static const fbxString  sDefaultFileName
static const fbxBool1  sDefaultEnableNearAttenuation
static const fbxDouble1  sDefaultNearAttenuationStart
static const fbxDouble1  sDefaultNearAttenuationEnd
static const fbxBool1  sDefaultEnableFarAttenuation
static const fbxDouble1  sDefaultFarAttenuationStart
static const fbxDouble1  sDefaultFarAttenuationEnd
static const fbxBool1  sDefaultCastShadows
static const fbxDouble3  sDefaultShadowColor

Properties
KFbxTypedProperty< ELightType >  LightType
  This property handles the light type.
KFbxTypedProperty< fbxBool1 >  CastLight
  This property handles the cast light on object flag.
KFbxTypedProperty< fbxBool1 >  DrawVolumetricLight
  This property handles the draw volumetric light flag.
KFbxTypedProperty< fbxBool1 >  DrawGroundProjection
  This property handles the draw ground projection flag.
KFbxTypedProperty< fbxBool1 >  DrawFrontFacingVolumetricLight
  This property handles the draw facing volumetric projection flag.
KFbxTypedProperty< fbxDouble3 >  Color
  This property handles the light color.
KFbxTypedProperty< fbxDouble1 >  Intensity
  This property handles the light intensity.
KFbxTypedProperty< fbxDouble1 >  HotSpot
  This property handles the light inner cone angle (in degrees).
KFbxTypedProperty< fbxDouble1 >  ConeAngle
  This property handles the light outer cone angle (in degrees).
KFbxTypedProperty< fbxDouble1 >  Fog
  This property handles the light fog intensity.
KFbxTypedProperty< EDecayType >  DecayType
  This property handles the decay type.
KFbxTypedProperty< fbxDouble1 >  DecayStart
  This property handles the decay start distance.
KFbxTypedProperty< fbxString >  FileName
  This property handles the gobo file name.
KFbxTypedProperty< fbxBool1 >  EnableNearAttenuation
  This property handles the enable near attenuation flag.
KFbxTypedProperty< fbxDouble1 >  NearAttenuationStart
  This property handles the near attenuation start distance.
KFbxTypedProperty< fbxDouble1 >  NearAttenuationEnd
  This property handles the near end attenuation.
KFbxTypedProperty< fbxBool1 >  EnableFarAttenuation
  This property handles the enable far attenuation flag.
KFbxTypedProperty< fbxDouble1 >  FarAttenuationStart
  This property handles the far attenuation start distance.
KFbxTypedProperty< fbxDouble1 >  FarAttenuationEnd
  This property handles the attenuation end distance.
KFbxTypedProperty< fbxBool1 >  CastShadows
  This property handles the cast shadow flag.
KFbxTypedProperty< fbxDouble3 >  ShadowColor
  This property handles the shadow color.

Public Member Functions
virtual EAttributeType  GetAttributeType () const
  Return the type of node attribute which is EAttributeType::eLIGHT.

Member Enumeration Documentation

enum ELightType

Light types.

  • ePOINT
  • eDIRECTIONAL
  • eSPOT

Definition at line 74 of file kfbxlight.h.

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.

Definition at line 88 of file kfbxlight.h.

Member Function Documentation

virtual EAttributeType GetAttributeType (  )  const [virtual]

Return the type of node attribute which is EAttributeType::eLIGHT.

Reimplemented from KFbxNodeAttribute.

void SetShadowTexture ( KFbxTexture *  pTexture  ) 

Set the shadow texture for the light.

Parameters:
pTexture  The texture cast by the light shadow.

KFbxTexture* GetShadowTexture (  )  const

Get the light state.

Returns:
Pointer to the texture cast by the light shadow, or NULL if the shadow texture has not been set.

Member Data Documentation

const char* sColor [static]

Property Names.

Reimplemented from KFbxNodeAttribute.

Definition at line 118 of file kfbxlight.h.

const fbxDouble3 sDefaultColor [static]

Property Default Values.

Reimplemented from KFbxNodeAttribute.

Definition at line 145 of file kfbxlight.h.

KFbxTypedProperty<ELightType> LightType

This property handles the light type.

To access this property do: LightType.Get(). To set this property do: LightType.Set(ELightType).

Default value is ePOINT

Definition at line 181 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> CastLight

This property handles the cast light on object flag.

To access this property do: CastLight.Get(). To set this property do: CastLight.Set(fbxBool1).

Default value is true

Definition at line 190 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> DrawVolumetricLight

This property handles the draw volumetric light flag.

To access this property do: DrawVolumetricLight.Get(). To set this property do: DrawVolumetricLight.Set(fbxBool1).

Default value is true

Definition at line 199 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> DrawGroundProjection

This property handles the draw ground projection flag.

To access this property do: DrawGroundProjection.Get(). To set this property do: DrawGroundProjection.Set(fbxBool1).

Default value is true

Definition at line 208 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> DrawFrontFacingVolumetricLight

This property handles the draw facing volumetric projection flag.

To access this property do: DrawFrontFacingVolumetricLight.Get(). To set this property do: DrawFrontFacingVolumetricLight.Set(fbxBool1).

Default value is false

Definition at line 217 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble3> Color

This property handles the light color.

To access this property do: Color.Get(). To set this property do: Color.Set(fbxDouble3).

Default value is (1.0, 1.0, 1.0)

Reimplemented from KFbxNodeAttribute.

Definition at line 226 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> Intensity

This property handles the light intensity.

To access this property do: Intensity.Get(). To set this property do: Intensity.Set(fbxDouble1).

Default value is 100.0

Definition at line 235 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> HotSpot

This property handles the light inner cone angle (in degrees).

Also know as the HotSpot!

To access this property do: HotSpot.Get(). To set this property do: HotSpot.Set(fbxDouble1).

Default value is 45.0

Definition at line 244 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> ConeAngle

This property handles the light outer cone angle (in degrees).

Also known as the Falloff

To access this property do: ConeAngle.Get(). To set this property do: ConeAngle.Set(fbxDouble1).

Default value is 45.0

Definition at line 253 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> Fog

This property handles the light fog intensity.

To access this property do: Fog.Get(). To set this property do: Fog.Set(fbxDouble1).

Default value is 50.0

Definition at line 262 of file kfbxlight.h.

KFbxTypedProperty<EDecayType> DecayType

This property handles the decay type.

To access this property do: DecayType.Get(). To set this property do: DecayType.Set(EDecayType).

Default value is eNONE

Definition at line 271 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> DecayStart

This property handles the decay start distance.

To access this property do: DecayStart.Get(). To set this property do: DecayStart.Set(fbxDouble1).

Default value is 0.0

Definition at line 280 of file kfbxlight.h.

KFbxTypedProperty<fbxString> FileName

This property handles the gobo file name.

To access this property do: FileName.Get(). To set this property do: FileName.Set(fbxString).

Default value is ""

Definition at line 289 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> EnableNearAttenuation

This property handles the enable near attenuation flag.

To access this property do: EnableNearAttenuation.Get(). To set this property do: EnableNearAttenuation.Set(fbxBool1).

Default value is false

Definition at line 298 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> NearAttenuationStart

This property handles the near attenuation start distance.

To access this property do: NearAttenuationStart.Get(). To set this property do: NearAttenuationStart.Set(fbxDouble1).

Default value is 0.0

Definition at line 307 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> NearAttenuationEnd

This property handles the near end attenuation.

To access this property do: NearAttenuationEnd.Get(). To set this property do: NearAttenuationEnd.Set(fbxDouble1).

Default value is 0.0

Definition at line 316 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> EnableFarAttenuation

This property handles the enable far attenuation flag.

To access this property do: EnableFarAttenuation.Get(). To set this property do: EnableFarAttenuation.Set(fbxBool1).

Default value is false

Definition at line 325 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> FarAttenuationStart

This property handles the far attenuation start distance.

To access this property do: FarAttenuationStart.Get(). To set this property do: FarAttenuationStart.Set(fbxDouble1).

Default value is 0.0

Definition at line 334 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble1> FarAttenuationEnd

This property handles the attenuation end distance.

To access this property do: FarAttenuationEnd.Get(). To set this property do: FarAttenuationEnd.Set(fbxDouble1).

Default value is 0.0

Definition at line 343 of file kfbxlight.h.

KFbxTypedProperty<fbxBool1> CastShadows

This property handles the cast shadow flag.

To access this property do: CastShadows.Get(). To set this property do: CastShadows.Set(fbxBool1).

Default value is false

Definition at line 352 of file kfbxlight.h.

KFbxTypedProperty<fbxDouble3> ShadowColor

This property handles the shadow color.

To access this property do: ShadowColor.Get(). To set this property do: ShadowColor.Set(fbxDouble3).

Default value is (0.0, 0.0, 0.0)

Definition at line 361 of file kfbxlight.h.

KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight
KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight KFbxLight