Shader Shadow Live class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBShaderShadowLive:

[legend]

Public Member Functions
	FBShaderShadowLive (str pName)
	Constructor.

Public Member Functions inherited from FBShader
	FBShader (str pName)
	Protected constructor.

bool	Append (FBModel pModel)
	Append shader to pModel.

	CloneShaderParameter (FBShader pNewShader)
	Clone shader.

bool	ReplaceAll (FBModel pModel)
	Replace all shader in pModel.

bool	ShaderNeedBeginRender ()
	Does the shader need a begin render call.

Public Member Functions inherited from FBBox
	FBBox (str pName)
	Constructor.

bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.

FBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.

bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?

FBAnimationNode	AnimationNodeOutGet ()

str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.

str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.

FBAnimationNode	GetInConnector (int pIndex)
	Get the animation node input associated with the given index.

int	GetInConnectorCount ()
	Get the number of animation node inputs for this box.

FBAnimationNode	GetOutConnector (int pIndex)
	Get the animation node output associated with the given index.

int	GetOutConnectorCount ()
	Get the number of animation node outputs for this box.

Public Member Functions inherited from FBComponent
	FBComponent ()
	Constructor.

str	ClassName ()
	Get the class name.

	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

bool	FBCreate ()
	Open Reality Creation function.

	FBDelete ()
	Open Reality deletion function.

	FBDestroy ()
	Open Reality destruction function.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

FBFileReference	GetOwnerFileReference (p0)
	Get the owner FileReference object.

	HardSelect ()
	HardSelect.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

bool	Is (int pTypeId)
	Returns true if object is of type TypeId.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, str pNamespaceName, str pReplaceTo=None, bool pAddRight=True)
	ProcessObjectNamespace.

int	PropertyAdd (FBProperty pProperty)
	Add a property to the component's property manager.

bool	PropertyAddReferenceProperty (FBProperty pReferenceProperty)
	Add a reference property to the component's property manager.

FBProperty	PropertyCreate (str pName, FBType pType, str pDataType, bool pAnimatable, bool pIsUser=False, FBProperty pReferenceSource=None)
	Create user or dynamic property.

	PropertyGetModifiedList (FBArrayTemplate< FB > pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

	PropertyRemove (FBProperty pProperty)
	Remove a Property from the component's Property manager.

	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

Public Attributes
FBListObject	Lights
	List: List of light object which will produce shadows.

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

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

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

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

FBShadowType	ShadowType
	Read Write Property: Indicate which shadow type is desired.

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

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

Public Attributes inherited from FBShader
FBRenderingPass	RenderingPass
	Read Write Property: Rendering pass object are shaded in.

str	ShaderDescription
	Description.

Public Attributes inherited from FBBox
bool	Animatable
	Read Write Property: Is the box animatable.

bool	Live
	Read Write Property: Is live?

bool	RecordMode
	Read Write Property: Is recording?

str	UniqueName
	internal Unique name.

Public Attributes inherited from FBComponent
FBListComponent	Components
	List: List of components.

str	LongName
	Read Write Property: Name and namespace for object.

str	Name
	Read Write Property: Unique name of object. See sample: RemoveSuffixFromNameOfSceneElements.py.

FBListComponent	Parents
	List: Parents.

FBManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

bool	Selected
	Read Write Property: Selected property.

int	TypeInfo
	Contains the Type information of the object.

Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.

int	TypeInfo
	TypeInfo.

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.Please consult the application documentation for more infos on shader properties and their effects.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 )

Constructor & Destructor Documentation

◆ FBShaderShadowLive()

FBShaderShadowLive ( str pName )

Constructor.

Parameters

pName Name of shader.

Member Data Documentation

◆ Lights

FBListObject Lights

List: List of light object which will produce shadows.

◆ LocalShadow

bool LocalShadow

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

◆ Models

FBListObject Models

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

◆ ShadowFrameType

FBShadowFrameType ShadowFrameType

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

◆ ShadowIntensity

FBAnimatableDouble ShadowIntensity

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

◆ ShadowType

FBShadowType ShadowType

Read Write Property: Indicate which shadow type is desired.

◆ ShadowZOffset

float ShadowZOffset

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

◆ UseGobo

bool UseGobo

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

Public Member Functions

Public Attributes