FBMaterial Class Reference

#include <mobu-python-api.h>

Class Description

Material class.

+ Inheritance diagram for FBMaterial:

Public Member Functions

 __reduce__ ()
 
object __copy__ (FBMaterial arg1)
 
 __init__ (object arg1, str arg2)
 Constructor. More...
 
 OGLInit (FBMaterial arg1)
 Setup OpenGL fixed pipeline material settings. More...
 
object Clone (FBMaterial arg1)
 Clone the material. More...
 
object GetTexture (FBMaterial arg1, FBMaterialTextureType arg2)
 Retrieve associated texture. More...
 
 SetTexture (FBMaterial arg1, FBTexture arg2, FBMaterialTextureType arg3)
 Set associated texture. More...
 
- Public Member Functions inherited from FBBox
 __reduce__ ()
 
bool AnimationNodeDestroy (FBBox arg1, FBAnimationNode arg2)
 Destroy an animation node. More...
 
 __init__ (object arg1, str arg2)
 Constructor. More...
 
object AnimationNodeInGet (FBBox arg1)
 Get the (IN/OUT) animation node for this box. More...
 
bool AnimationNodeIsUserData (FBBox arg1, FBAnimationNode arg2)
 Is the animation node user data? More...
 
object AnimationNodeOutGet (FBBox arg1)
 
int GetOutConnectorCount (FBBox arg1)
 Get the number of animation node outputs for this box. More...
 
int GetInConnectorCount (FBBox arg1)
 Get the number of animation node inputs for this box. More...
 
object GetOutConnector (FBBox arg1, object arg2)
 Get the animation node output associated with the given index. More...
 
object GetInConnector (FBBox arg1, object arg2)
 Get the animation node input associated with the given index. More...
 
- Public Member Functions inherited from FBComponent
 __reduce__ ()
 
FBPropertyList PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
 Get list of properties which have been modified since last loading. More...
 
str ClassName (FBComponent arg1)
 Get the class name. More...
 
 DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Disable a specific Object Flags. More...
 
 EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Enable a specific Object Flags. More...
 
bool FBCreate (FBComponent arg1)
 Open Reality Creation function. More...
 
 FBDelete (FBComponent arg1)
 Open Reality deletion function. More...
 
 FBDestroy (FBComponent arg1)
 Open Reality destruction function. More...
 
FBObjectFlag GetObjectFlags (FBComponent arg1)
 Get all Object Flags (concatenated). More...
 
bool GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
 Check to see if an object status is enabled. More...
 
bool HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 Check whether a specific object flag is enabled. More...
 
bool Is (FBComponent arg1, object arg2)
 Returns true if object is of type TypeId. More...
 
bool ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessNamespaceHierarchy. More...
 
bool ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
 ProcessObjectNamespace. More...
 
int PropertyAdd (FBComponent arg1, FBProperty arg2)
 Add a property to the component's property manager. More...
 
bool PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
 Add a reference property to the component's property manager. More...
 
object PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
 Create user or dynamic property. More...
 
 PropertyRemove (FBComponent arg1, FBProperty arg2)
 Remove a Property from the component's Property manager. More...
 
 SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
 SetObjectFlags. More...
 
 SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
 Enable/Disable a specific Object Status. More...
 
 HardSelect (FBComponent arg1)
 HardSelect. More...
 
object GetOwnerFileReference (FBComponent arg1)
 Get the owner FileReference object. More...
 
 __init__ (...)
 Constructor. More...
 
- Public Member Functions inherited from FBPlug
 __reduce__ ()
 
bool BeginChange (FBPlug arg1)
 Begins a change on multiple plugs. More...
 
str ClassName (FBPlug arg1)
 internal System vars. More...
 
bool ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a destination connection. More...
 
bool ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a destination connection. More...
 
bool ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
 Add a source connection. More...
 
bool ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
 Add a source connection. More...
 
 DisconnectAllDst (FBPlug arg1)
 Remove all destination connections. More...
 
 DisconnectAllSrc (FBPlug arg1)
 Remove all source connections. More...
 
bool DisconnectDst (FBPlug arg1, FBPlug arg2)
 Remove a destination connection. More...
 
bool DisconnectDstAt (FBPlug arg1, object arg2)
 Remove a destination connection at a specified index. More...
 
bool DisconnectSrc (FBPlug arg1, FBPlug arg2)
 Remove a source connection. More...
 
bool DisconnectSrcAt (FBPlug arg1, object arg2)
 Remove a source connection at a specified index. More...
 
 EndChange (FBPlug arg1)
 Ends a change on multiple plugs. More...
 
object GetDst (FBPlug arg1, object arg2)
 Get a destination connection's plug at specified index. More...
 
int GetDstCount (FBPlug arg1)
 Get destination connection count. More...
 
FBConnectionType GetDstType (FBPlug arg1, object arg2)
 Get a destination connection's type at specified index. More...
 
object GetOwned (FBPlug arg1, object arg2)
 Get the owned plug at specified index. More...
 
int GetOwnedCount (FBPlug arg1)
 Get the owned plug count. More...
 
object GetOwner (FBPlug arg1)
 Get the owner of this plug. More...
 
object GetSrc (FBPlug arg1, object arg2)
 Get a source connection's plug at specified index. More...
 
int GetSrcCount (FBPlug arg1)
 Get source connection count. More...
 
FBConnectionType GetSrcType (FBPlug arg1, object arg2)
 Get a source connection's type at specified index. More...
 
bool Is (FBPlug arg1, object arg2)
 Is( int pTypeId ) More...
 
bool IsSDKComponent (FBPlug arg1)
 Return whether or not item is an SDK component. More...
 
 MoveSrcAt (...)
 
bool ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a destination connection at a specified index. More...
 
bool ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
 Replace a source connection at a specified index. More...
 
bool SwapSrc (FBPlug arg1, object arg2, object arg3)
 Swap source connection at index A with source connection at index B. More...
 
 SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's self modification flag. More...
 
bool GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's self has changed. More...
 
 SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
 Set the plug's owned property/object's modification flag. More...
 
bool GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
 Tell if the plug's content has changed. More...
 
int GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
 Get plug's modified src/dst property/object connection added/removed List. More...
 
bool RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
 Revert the plug's modification to original status. More...
 
 __init__ (...)
 
method staticmethod (function)
 
- Public Member Functions inherited from FBPythonWrapper
 __reduce__ ()
 
 __init__ (...)
 

Public Attributes

FBPropertyAnimatableColor Ambient
 Read Write Property: Ambient color. More...
 
FBPropertyAnimatableDouble AmbientFactor
 Read Write Property: Ambient Factor value. More...
 
FBPropertyAnimatableColor Diffuse
 Read Write Property: Diffuse color. More...
 
FBPropertyAnimatableDouble DiffuseFactor
 Read Write Property: Diffuse Factor value. More...
 
FBPropertyAnimatableColor Emissive
 Read Write Property: Emissive color. More...
 
FBPropertyAnimatableDouble EmissiveFactor
 Read Write Property: Emissive Factor value. More...
 
FBPropertyAnimatableColor TransparentColor
 Read Write Property: Transparent color. More...
 
FBPropertyAnimatableDouble TransparencyFactor
 Read Write Property: Transparency Factor value. More...
 
FBPropertyAnimatableColor Bump
 Read Write Property: Bump. More...
 
FBPropertyAnimatableColor NormalMap
 Read Write Property: Normal Map. More...
 
FBPropertyAnimatableDouble BumpFactor
 Read Write Property: Bump Factor value. More...
 
FBPropertyAnimatableColor Reflection
 Read Write Property: Reflection color. More...
 
FBPropertyAnimatableDouble ReflectionFactor
 Read Write Property: Reflection Factor value. More...
 
FBPropertyAnimatableDouble Shininess
 Read Write Property: Shininess value. More...
 
FBPropertyAnimatableDouble SpecularFactor
 Read Write Property: Specular Factor value. More...
 
FBPropertyAnimatableColor Specular
 Read Write Property: Specular color. More...
 
FBPropertyAnimatableColor DisplacementColor
 Read Write Property: Displacement color. More...
 
FBPropertyAnimatableDouble DisplacementFactor
 Read Write Property: Displacement Factor value. More...
 
- Public Attributes inherited from FBBox
FBPropertyBool Animatable
 Read Write Property: Is the box animatable. More...
 
FBPropertyBool Live
 Read Write Property: Is live? More...
 
FBPropertyBool RecordMode
 Read Write Property: Is recording? More...
 
const char * UniqueName
 internal Unique name. More...
 
- Public Attributes inherited from FBComponent
object OwnerNamespace
 
ORSDK2018::FBPropertyListComponent Components
 List: List of components. More...
 
ORSDK2018::FBPropertyString Name
 Read Write Property: Unique name of object. More...
 
ORSDK2018::FBPropertyString LongName
 Read Write Property: Name and namespace for object. More...
 
object FullName
 
ORSDK2018::FBPropertyListComponent Parents
 List: Parents. More...
 
ORSDK2018::FBPropertyManager PropertyList
 Read Only Property: Manages all of the properties for the component. More...
 
FBPropertyBool Selected
 Read Write Property: Selected property. More...
 
- Public Attributes inherited from FBPythonWrapper
object OnUnbind
 

Member Function Documentation

object __copy__ ( FBMaterial  arg1)

Python Docstring:

__copy__( (FBMaterial)arg1) -> object 
__init__ ( object  arg1,
str  arg2 
)

Constructor.

Python Docstring:

__init__( (object)arg1, (str)arg2) -> None 

C++ Signature:

 FBMaterial(const char * pName, HIObject pObject = ((void *) 0)) 
Parameters
pNameName of material.
pObjectFor internal use only(default=NULL).
__reduce__ ( )
object Clone ( FBMaterial  arg1)

Clone the material.

Python Docstring:

Clone( (FBMaterial)arg1) -> object 

C++ Signature:

ORSDK2018::FBMaterial * Clone() 

This will duplicated the current material.

Returns
Newly created material.
object GetTexture ( FBMaterial  arg1,
FBMaterialTextureType  arg2 
)

Retrieve associated texture.

Python Docstring:

GetTexture( (FBMaterial)arg1 [, (FBMaterialTextureType)arg2]) -> object 

C++ Signature:

ORSDK2018::FBTexture * GetTexture(FBMaterialTextureType pType = kFBMaterialTextureDiffuse) 
Parameters
pTypeMaterialTextureType to get connected texture from (default is Diffuse is not specified).
OGLInit ( FBMaterial  arg1)

Setup OpenGL fixed pipeline material settings.

Python Docstring:

OGLInit( (FBMaterial)arg1) -> None 

C++ Signature:

void OGLInit() 
SetTexture ( FBMaterial  arg1,
FBTexture  arg2,
FBMaterialTextureType  arg3 
)

Set associated texture.

Python Docstring:

SetTexture( (FBMaterial)arg1, (FBTexture)arg2 [, (FBMaterialTextureType)arg3]) -> None 

C++ Signature:

void SetTexture(ORSDK2018::FBTexture * pTexture, FBMaterialTextureType pType = kFBMaterialTextureDiffuse) 
Parameters
pTexturetexture to be connected.
pTypeMaterialTextureType to set connected texture to.

Member Data Documentation

Read Write Property: Ambient color.

Read Write Property: Ambient Factor value.

Read Write Property: Bump.

Read Write Property: Bump Factor value.

Read Write Property: Diffuse color.

Read Write Property: Diffuse Factor value.

FBPropertyAnimatableColor DisplacementColor

Read Write Property: Displacement color.

FBPropertyAnimatableDouble DisplacementFactor

Read Write Property: Displacement Factor value.

Read Write Property: Emissive color.

Read Write Property: Emissive Factor value.

Read Write Property: Normal Map.

Read Write Property: Reflection color.

FBPropertyAnimatableDouble ReflectionFactor

Read Write Property: Reflection Factor value.

Read Write Property: Shininess value.

Read Write Property: Specular color.

Read Write Property: Specular Factor value.

FBPropertyAnimatableDouble TransparencyFactor

Read Write Property: Transparency Factor value.

FBPropertyAnimatableColor TransparentColor

Read Write Property: Transparent color.