Python Reference Guide
 
Loading...
Searching...
No Matches
FBLayeredTexture Class Reference

LayeredTexture class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBLayeredTexture:

Public Member Functions

 FBLayeredTexture (str pName)
 Constructor.
 
FBLayeredTexture Clone ()
 Clone the current texture.
 
 FBDelete ()
 Open Reality deletion function.
 
 SetLayerConfigDirty ()
 Set layer config dirty to trigger new composition.
 
- Public Member Functions inherited from FBTexture
 FBTexture (str pName)
 Constructor.
 
FBTexture Clone ()
 Clone the texture.
 
 FBDelete ()
 
 OGLInit (FBRenderOptions pRenderOptions=None)
 
- 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

FBAnimatableColorAndAlpha BackgroundColor
 Read/Write Property: Animatable Background color which is used to clear color buffer before composition.

 
FBListTexture Layers
 Read/Write Property: Textures Layers.

 
- Public Attributes inherited from FBTexture
FBAnimatableDouble Alpha
 Read Write Property: Texture alpha value.

 
FBTextureBlendMode BlendMode
 Read Write Property: Texture blend mode.

 
int Height
 Read Only Property: Height of texture.

 
FBTextureMapping Mapping
 Read Write Property: Texture mapping.

 
FBAnimatableVector3d Rotation
 Read Write Property: Rotation coordinates.

 
FBAnimatableVector3d Scaling
 Read Write Property: Scaling coordinates.

 
bool SwapUV
 Read Write Property: Swap UV coordinates?

 
int TextureOGLId
 Read Only: OpenGL texture buffer object Id.

 
FBAnimatableVector3d Translation
 Read Write Property: Translation coordinates.

 
FBTextureUseType UseType
 Read Write Property: Texture Use Type.

 
FBVideo Video
 Read Write Property: Media used for texturing.

 
int Width
 Read Only Property: Width of texture.

 
- 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

LayeredTexture class.


This class is used to encapsulate list of textures. User could subclass this class to support customized blending & compostion modes. See /OpenRealitySDK/Samples/miscellaneous/texture_template/ for example.

See sample: LayeredTexture.py.

Constructor & Destructor Documentation

◆ FBLayeredTexture()

FBLayeredTexture ( str  pName)

Constructor.

Parameters
pNameName of texture media. Can be a NULL pointer. If set, this will create a FBVideo object used as the Video property.

Member Function Documentation

◆ Clone()

FBLayeredTexture Clone ( )

Clone the current texture.

Duplicates the current texture.

Returns
Newly created texture.

◆ FBDelete()

FBDelete ( )

Open Reality deletion function.

See sample: DeleteHierarchy.py.

◆ SetLayerConfigDirty()

SetLayerConfigDirty ( )

Set layer config dirty to trigger new composition.

Member Data Documentation

◆ BackgroundColor

FBAnimatableColorAndAlpha BackgroundColor

Read/Write Property: Animatable Background color which is used to clear color buffer before composition.

◆ Layers

FBListTexture Layers

Read/Write Property: Textures Layers.