FBSurface Class Reference

Surface class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBSurface:

Public Member Functions
	FBSurface (str pName)
	Constructor.
	ControlPointsBegin ()
	ControlPointsEnd ()
	GetControlPoint (int pIndex, float pX, float pY, float pZ, float pW)
bool	GetSurfaceCapped (int pUorV, int pDirection)
	SetControlPoint (int pIndex, float pX, float pY, float pZ, float pW)
	SurfaceBegin ()
	SurfaceEditBegin ()
	SurfaceEditEnd ()
	SurfaceEnd ()
bool	VertexGetSelected (int pU, int pV)
	Get the selected state of a vertex.
bool	VertexGetTransformable (int pU, int pV)
	Get the Transformable state of a vertex.
bool	VertexGetVisible (int pU, int pV)
	Get the visible state of a vertex.
bool	VertexSetSelected (int pU, int pV, bool pState)
	Set the selected state of a vertex.
bool	VertexSetVisible (int pU, int pV, bool pState)
	Set the visible state of a vertex.
Public Member Functions inherited from FBGeometry
bool	GeometryBegin ()
	Begin geometry editing.
bool	GeometryEnd ()
	End geometry editing.
FBNormal	GetBinormalsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of binormals.
int	GetBinormalsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of binormals.
int	GetMaterialIndexArray (int pOutArrayCount)
	Get a pointer to the index array of Material.
FBNormal	GetNormalsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of normals.
int	GetNormalsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of normals.
FBVertex	GetPositionsArray (int pOutArrayCount)
	Get a pointer to the position array.
FBNormal	GetTangentsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of tangents.
int	GetTangentsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of tangents.
FBUV	GetUVSetDirectArray (int pOutArrayCount, str pUVSetName=None)
	Get a pointer to the direct array of UVset Modify array value will be only effective when geometry editing is enabled.
int	GetUVSetIndexArray (int pOutArrayCount, str pUVSetName=None)
	Get a pointer to the index array of UVset.
FBGeometryMappingMode	GetUVSetMappingMode (str pUVSetName=None)
	Get UVSet mapping mode.
FBGeometryReferenceMode	GetUVSetReferenceMode (str pUVSetName=None)
	Get UVSet reference mode.
FBStringList	GetUVSets ()
	Get available UVSet name.
FBColorF	GetVertexColorsDirectArray (int pOutArrayCount)
	Get a pointer to the direct array of vertex color.
int	GetVertexColorsIndexArray (int pOutArrayCount)
	Get a pointer to the index array of vertex color.
int	ShapeAdd (str pName)
	Add new shape.
	ShapeClearAll ()
	Clears all the shapes.
int	ShapeGetCount ()
	Get Shape Count.
str	ShapeGetName (int pShapeIdx)
	Return the shape Name.
	ShapeInit (int pShapeIdx, int pDiffSize, bool pWithNormal=False)
	Init the shape.
bool	ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, FBVertex pPosDiff)
	Set the differentiate point.
bool	ShapeSetDiffPoint (int pShapeIdx, int pDiffIndex, int pOriIndex, FBVertex pPosDiff, FBNormal pNormalDiff)
	Set the differentiate point.
int	VertexAdd (FBVertex pVertex)
	Add a vertex.
int	VertexAdd (FBVertex pVertex, FBNormal pNormal)
	Add a vertex.
int	VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV)
	Add a vertex.
int	VertexAdd (FBVertex pVertex, FBNormal pNormal, FBUV pUV, FBColorF pVertexColor)
	Add a vertex.
int	VertexAdd (float px, float py, float pz)
	Add a vertex.
int	VertexAdd (float px, float py, float pz, float nx, float ny, float nz)
	Begin geometry editing.
int	VertexAdd (float px, float py, float pz, float nx, float ny, float nz, float UVu, float UVv)
	Begin geometry editing.
int	VertexAdd (float px, float py, float pz, float nx, float ny, float nz, float UVu, float UVv, float pRed, float pGreen, float pBlue, float pAlpha)
	Begin geometry editing.
bool	VertexArrayClear ()
	Clear all geometry vertex arrays.
bool	VertexArrayInit (int pVertexcount, bool pUniqueMaterial, unsigned int pFBGeometryArrayIDs=0)
	Init geometry vertex arrays.
bool	VertexClear ()
	Clear all Vertex arrays.
FBColorF	VertexColorGet (int pIndex=-1)
	Get a Vertex Color.
bool	VertexColorSet (FBColorF pColor, int pIndex=-1)
	Set a Vertex Color.
bool	VertexColorSet (float pRed, float pGreen, float pBlue, float pAlpha, int pIndex=-1)
	Set a UV coordinate.
int	VertexCount ()
	Get the number of vertices in the geometry.
FBVertex	VertexGet (int pIndex)
	Get a vertex.
bool	VertexGetSelected (int pIndex)
	Get the selected state of a vertex.
bool	VertexGetTransformable (int pIndex)
	Get the Transformable state of a vertex.
bool	VertexGetVisible (int pIndex)
	Get the visible state of a vertex.
	VertexInit (int pSize, bool pResize, bool pInitUV=True, bool pInitVertexColor=False)
	Resize or Reserve vertex, normal and UV array for performance.
FBNormal	VertexNormalGet (int pIndex=-1)
	Get a normal at a vertex.
bool	VertexNormalSet (FBNormal pVertex, int pIndex=-1)
	Set a normal at a vertex.
bool	VertexNormalSet (float px, float py, float pz, int pIndex=-1)
	Set a normal at a vertex.
bool	VertexSet (FBVertex pVertex, int pIndex=-1)
	Set a vertex.
bool	VertexSet (float px, float py, float pz, int pIndex=-1)
	Set a vertex.
bool	VertexSetSelected (int pIndex, bool pState)
	Set the selected state of a vertex.
bool	VertexSetVisible (int pIndex, bool pState)
	Set the visible state of a vertex.
FBUV	VertexUVGet (int pIndex=-1)
	Get a UV coordinate.
bool	VertexUVSet (FBUV pUV, int pIndex=-1)
	Set a UV coordinate.
bool	VertexUVSet (float pU, float pV, int pIndex=-1)
	Set a UV coordinate.
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
FBSurfaceMode	SurfaceMode
	Read Write Property: Surface mode.
bool	UClosed
	Read Write Property: U Closed.
int	USize
	Read Write Property: Size in U directions.
int	UStep
	Read Write Property: Step in U directions.
bool	VClosed
	Read Write Property: V Closed
int	VSize
	Read Write Property: Size in V directions.
int	VStep
	Read Write Property: Step in V directions.
Public Attributes inherited from FBGeometry
FBGeometryMappingMode	BinormalMappingMode
	Read Only Property: Binormal mapping mode.
FBGeometryReferenceMode	BinormalReferenceMode
	Read Only Property: Binormal reference mode.
FBGeometryMappingMode	MaterialMappingMode
	Read Property: Material mapping mode.
FBGeometryMappingMode	NormalMappingMode
	Read Only Property: Normal mapping mode.
FBGeometryReferenceMode	NormalReferenceMode
	Read Only Property: Normal reference mode.
FBGeometryMappingMode	TangentMappingMode
	Read Only Property: Tangent mapping mode.
FBGeometryReferenceMode	TangentReferenceMode
	Read Only Property: Tangent reference mode.
FBGeometryMappingMode	VertexColorMappingMode
	Read Only Property: Vertex Color mapping mode.
FBGeometryReferenceMode	VertexColorReferenceMode
	Read Only Property: Vertex Color reference mode.
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

Surface class.

Constructor & Destructor Documentation

FBSurface()

FBSurface

(

str

pName

)

Constructor.

Parameters

pName

Name of Surface.

Member Function Documentation

ControlPointsBegin()

ControlPointsBegin

(

)

ControlPointsEnd()

ControlPointsEnd

(

)

GetControlPoint()

GetControlPoint	(	int	pIndex,
		float	pX,
		float	pY,
		float	pZ,
		float	pW
	)

GetSurfaceCapped()

bool GetSurfaceCapped	(	int	pUorV,
		int	pDirection
	)

SetControlPoint()

SetControlPoint	(	int	pIndex,
		float	pX,
		float	pY,
		float	pZ,
		float	pW
	)

SurfaceBegin()

SurfaceBegin

(

)

SurfaceEditBegin()

SurfaceEditBegin

(

)

SurfaceEditEnd()

SurfaceEditEnd

(

)

SurfaceEnd()

SurfaceEnd

(

)

VertexGetSelected()

bool VertexGetSelected	(	int	pU,
		int	pV
	)

Get the selected state of a vertex.

Parameters

pU	The u index of the vertex.
pV	The v index of the vertex.

Returns

true if the vertex is selected, false if not.

VertexGetTransformable()

bool VertexGetTransformable	(	int	pU,
		int	pV
	)

Get the Transformable state of a vertex.

Parameters

pU	The u index of the vertex.
pV	The v index of the vertex.

Returns

true if the vertex is Transformable, false if not.

VertexGetVisible()

bool VertexGetVisible	(	int	pU,
		int	pV
	)

Get the visible state of a vertex.

Parameters

pU	The u index of the vertex.
pV	The v index of the vertex.

Returns

true if the vertex is visible, false if not.

VertexSetSelected()

bool VertexSetSelected	(	int	pU,
		int	pV,
		bool	pState
	)

Set the selected state of a vertex.

Parameters

pU	The u index of the vertex.
pV	The v index of the vertex.
pState	Set the select state.

Returns

true if the vertex is selected, false if not.

VertexSetVisible()

bool VertexSetVisible	(	int	pU,
		int	pV,
		bool	pState
	)

Set the visible state of a vertex.

Parameters

pU	The u index of the vertex.
pV	The v index of the vertex.
pState	Set the visible state.

Returns

true if the vertex is visible, false if not.

Member Data Documentation

SurfaceMode

FBSurfaceMode SurfaceMode

Read Write Property: Surface mode.

UClosed

bool UClosed

Read Write Property: U Closed.

USize

int USize

Read Write Property: Size in U directions.

UStep

int UStep

Read Write Property: Step in U directions.

VClosed

bool VClosed

Read Write Property: V Closed

VSize

int VSize

Read Write Property: Size in V directions.

VStep

int VStep

Read Write Property: Step in V directions.