Public Types | Public Member Functions | Public Attributes

FBLight Class Reference

This reference page is linked to from the following overview topics: MotionBuilder 2014, Your First Python Program, Scene Elements, FBModel - Transformation Data and the Scene Graph, FBLight - Lights, Updated Objects.


Search for all occurrences

Detailed Description

Light class.

Definition at line 85 of file fblight.h.

#include <fblight.h>

Inheritance diagram for FBLight:
Inheritance graph
[legend]

List of all members.

Public Types

enum  EAreaLightShapes { eRectangle, eSphere }
 

Area light shapes.

More...
typedef FBPropertyBaseEnum
< EAreaLightShapes
PropertyAreaLightShapes

Public Member Functions

 FBLight (const char *pName, HIObject pObject=NULL)
 Constructor.

Public Attributes

FBPropertyLightType LightType
 Read Write Property: Type of light.
PropertyAreaLightShapes AreaLightShape
 Read Write Property: Area light shape.
FBPropertyAttenuationType AttenuationType
 Read Write Property: Type of attenuation for the light.
FBPropertyAnimatableDouble Intensity
 Read Write Property: Light intensity.
FBPropertyAnimatableDouble InnerAngle
 Read Write Property: Inner Cone angle for light.
FBPropertyAnimatableDouble OuterAngle
 Read Write Property: Outer Cone angle for light.
FBPropertyAnimatableDouble ConeAngle
  DEPRECATED Equivalent to OuterAngle.
FBPropertyAnimatableDouble FogIntensity
 Read Write Property: Intensity of the fog (spot light).
FBPropertyAnimatableColor DiffuseColor
 Read Write Property: Color: Diffuse color.
FBPropertyBool CastLightOnObject
 Read Write Property: Cast light on object?
FBPropertyBool CastShadows
 Read Write Property: Cast shadows on object?
FBPropertyBool DrawGroundProjection
 Read Write Property: Draw ground projection of gobo?
FBPropertyBool DrawVolumetricLight
 Read Write Property: Draw volumetric light with gobo?
FBPropertyBool DrawFrontFacingVolumetric
 Read Write Property: Draw front facing volumetric light?
FBPropertyVideo GoboMedia
 Read Write Property: Media to use as a Gobo with the light.
FBPropertyBool EnableBarnDoor
 Read Write Property: Whether or not enable barn door.
FBPropertyDouble LeftBarnDoor
 Read Write Property: Angle of left barn door.
FBPropertyDouble RightBarnDoor
 Read Write Property: Angle of right barn door.
FBPropertyDouble TopBarnDoor
 Read Write Property: Angle of top barn door.
FBPropertyDouble BottomBarnDoor
 Read Write Property: Angle of bottom barn door.

Member Typedef Documentation

Definition at line 101 of file fblight.h.


Member Enumeration Documentation

Area light shapes.

Enumerator:
eRectangle 

Rectangle.

eSphere 

Sphere.

Definition at line 96 of file fblight.h.


Constructor & Destructor Documentation

FBLight ( const char *  pName,
HIObject  pObject = NULL 
)

Constructor.

Parameters:
pNameName of light.
pObjectFor internal use only(default=NULL).

Member Data Documentation

FBPropertyLightType LightType

Read Write Property: Type of light.

MoBu default renderer don't support Area Light, it's useful for pipeline interop with other DCC tools, and custom renderer (or shader) plugin development.

Note:
To use Area Light, please set FBRenderer::AdvancedLightingMode property, or modify config "AdvancedLightingUISetting" at [Rendering] section.

Definition at line 111 of file fblight.h.

Read Write Property: Area light shape.

Definition at line 112 of file fblight.h.

FBPropertyAttenuationType AttenuationType

Read Write Property: Type of attenuation for the light.

Definition at line 113 of file fblight.h.

Read Write Property: Light intensity.

Definition at line 114 of file fblight.h.

Read Write Property: Inner Cone angle for light.

Definition at line 115 of file fblight.h.

Read Write Property: Outer Cone angle for light.

Definition at line 116 of file fblight.h.

DEPRECATED Equivalent to OuterAngle.

Definition at line 117 of file fblight.h.

Read Write Property: Intensity of the fog (spot light).

Definition at line 118 of file fblight.h.

Read Write Property: Color: Diffuse color.

Definition at line 119 of file fblight.h.

Read Write Property: Cast light on object?

Definition at line 120 of file fblight.h.

Read Write Property: Cast shadows on object?

Definition at line 121 of file fblight.h.

Read Write Property: Draw ground projection of gobo?

Definition at line 124 of file fblight.h.

Read Write Property: Draw volumetric light with gobo?

Definition at line 125 of file fblight.h.

Read Write Property: Draw front facing volumetric light?

Definition at line 126 of file fblight.h.

FBPropertyVideo GoboMedia

Read Write Property: Media to use as a Gobo with the light.

Definition at line 127 of file fblight.h.

Read Write Property: Whether or not enable barn door.

Definition at line 129 of file fblight.h.

Read Write Property: Angle of left barn door.

Definition at line 130 of file fblight.h.

Read Write Property: Angle of right barn door.

Definition at line 131 of file fblight.h.

Read Write Property: Angle of top barn door.

Definition at line 132 of file fblight.h.

Read Write Property: Angle of bottom barn door.

Definition at line 133 of file fblight.h.


The documentation for this class was generated from the following file:

FBLight FBLight FBLight FBLight FBLight FBLight FBLight FBLight FBLight FBLight
FBLight FBLight FBLight FBLight FBLight FBLight FBLight FBLight FBLight FBLight