FBShaderShadowLive Class Reference


Detailed Description

Shader Shadow Live class.

Use the Live Shadow shader to apply real-time shadows to models. You can specify shadow intensity as well as the lights and objects that cast shadows in a scene.

There are two methods to create a FBShaderShadowLive object: using the FBShaderManager, or simply by instantiating a class object explicitely.

Note:
Please consult the application documentation for more infos on shader properties and their effects.
Warning:
This class should not serve as a base class for another class.

Sample C++ code:

    // Create a shadow shader.
    FBShaderShadowLive* lShader = new FBShaderShadowLive( "New Shader" );

    // Add a cube in its list of affected objects.
    FBModel* lModel = FBFindModelByLabelName( "Cube" )
    if( lModel )
    {
    lShaderShadowLive.Add( lCube );
    }

Sample Python code:

    from pyfbsdk import *

    # Create shader.
    lShader = FBShaderShadowLive( 'New Python Shader' )

    # Find a cube to put in our list of affected objects.
    lModel = FBFindModelByLabelName( 'Cube' )
    if lModel:
    lShader.ShadowCasterProperty.append( lModel )
Inheritance diagram for FBShaderShadowLive:

List of all members.

Public Member Functions

 __init__ (str pName, object pObject=None)
 Constructor.

Public Attributes

FBPropertyShadowType ShadowType
 Read Write Property: Indicate which shadow type is desired.
FBPropertyBaseAnimatable ShadowIntensity
 Read Write Property: Controls the darkness of shadows cast by a selected object.
FBPropertyBase LocalShadow
 Read Write Property: Creates an accurate projection of a shadow for each object.
FBPropertyBase UseGobo
 Read Write Property: Includes the gobo in the shadow map calculation.
FBPropertyBase ShadowZOffset
 Read Write Property: Specifies the offset of the Live Shadow shader's plane from the original selected plane.
FBPropertyShadowFrameType ShadowFrameType
 Read Write Property: Used to select the shadow calculation method.
FBPropertyListObject Lights
 List: List of light object which will produce shadows.
FBPropertyListObject Models
 List: List of object which when lighted will cast a shadow.

Member Function Documentation

__init__ ( str  pName,
object  pObject = None 
)

Constructor.

Parameters:
pNameName of shader.
pObjectInternal parent object to own shader (default is NULL).

Reimplemented from FBShader.


Member Data Documentation

FBPropertyShadowType ShadowType

Read Write Property: Indicate which shadow type is desired.

FBPropertyBaseAnimatable ShadowIntensity

Read Write Property: Controls the darkness of shadows cast by a selected object.

FBPropertyBase LocalShadow

Read Write Property: Creates an accurate projection of a shadow for each object.

FBPropertyBase UseGobo

Read Write Property: Includes the gobo in the shadow map calculation.

FBPropertyBase ShadowZOffset

Read Write Property: Specifies the offset of the Live Shadow shader's plane from the original selected plane.

FBPropertyShadowFrameType ShadowFrameType

Read Write Property: Used to select the shadow calculation method.

List: List of light object which will produce shadows.

List: List of object which when lighted will cast a shadow.


FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive
FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive FBShaderShadowLive