#include <mobu-python-api.h>

Class Description

Objects Containing class.

This class is an interface to manipulate object's containing in the scene.

Inheritance diagram for FBFileReference:

Public Member Functions
	__reduce__ ()

	FBDelete (FBFileReference arg1)

	__init__ (object arg1, str arg2, FBNamespace arg3)

bool	BakeRefEditToFile (FBFileReference arg1, str arg2)
	Save the current status of the referenced content back to disk. More...

	RevertRefEdit (FBFileReference arg1, FBPlug arg2, FBPlugModificationFlag arg3)
	Revert the modification on the referenced object/property to original state. More...

	ApplyRefEditPyScriptFromFile (FBFileReference arg1, str arg2)
	Apply specified reference edits from python script file. More...

	ApplyRefEditPyScriptFromString (FBFileReference arg1, str arg2)
	Apply specified reference edits from Python script string. More...

bool	DuplicateFileRef (FBFileReference arg1, FBStringList arg2, object arg3)
	Duplicate/Clone the FileRef object and its referenced content (with/without refEdit). More...

str	GetRefEdit (FBFileReference arg1, str arg2)
	Return the RefEdit for given RefFile Path. More...

bool	ClearRefEdit (FBFileReference arg1, str arg2)
	Clear the cached RefEdit for the given ref file path. More...

bool	ClearAllRefEdit (FBFileReference arg1)
	Clear all cached Ref edit. More...

bool	SwapReferenceFilePath (FBFileReference arg1, str arg2, object arg3, object arg4)
	Swap the Ref File Path and apply ref edit. More...

	GetRefFileList (FBFileReference arg1, FBStringList arg2)
	Return a list of ref file path which has cached Ref Edit. More...

Public Member Functions inherited from FBNamespace
	__reduce__ ()

	FBDelete (FBNamespace arg1)

	__init__ (object arg1, str arg2, FBNamespace arg3)

int	GetContentCount (FBNamespace arg1)
	Get the namespace content objects count (Not Recursive). More...

object	GetContent (FBNamespace arg1, object arg2)
	Get the namespace content object count (Not Recursive). More...

	GetContentList (FBNamespace arg1, FBComponentList arg2, FBPlugModificationFlag arg3, object arg4, object arg5, object arg6)
	Get List of the namespace content. 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
ORSDK2018::FBPropertyString	ReferenceFilePath
	Read Write Property: File Reference file path. More...

FBPropertyBool	IsLoaded
	Read Write Property: File Reference Load/Unload. More...

Public Attributes inherited from FBNamespace
object	ContentCount

ORSDK2018::FBPropertyListNamespace	ChildrenNamespaces
	List: Direct Children Namespace Objects. 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

__init__	(	object	arg1,
		str	arg2,
		FBNamespace	arg3
	)

Python Docstring:

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

C++ Constructors:
The reference documentation for the following C++ symbols may contain additional relevant information.

 FBFileReference(const char * pMultiLevelNamespace, HIObject pObject)
 FBFileReference(const char * pSingleLevelNamespace, ORSDK2018::FBNamespace * pParentNSObj)

__reduce__ ( )

ApplyRefEditPyScriptFromFile	(	FBFileReference	arg1,
		str	arg2
	)

Apply specified reference edits from python script file.

Python Docstring:

ApplyRefEditPyScriptFromFile( (FBFileReference)arg1, (str)arg2) -> None

C++ Signature:

void ApplyRefEditPyScriptFromFile(const char * pRefEditPyScriptFilePath)

Parameters

pRefEditPyScriptFilePath Reference edits Python script file path.

See the C++ reference

ApplyRefEditPyScriptFromString	(	FBFileReference	arg1,
		str	arg2
	)

Apply specified reference edits from Python script string.

Python Docstring:

ApplyRefEditPyScriptFromString( (FBFileReference)arg1, (str)arg2) -> None

C++ Signature:

void ApplyRefEditPyScriptFromString(const char * pRefEditPyScript)

Parameters

pRefEditPyScript Reference edits Python script.

See the C++ reference

bool BakeRefEditToFile	(	FBFileReference	arg1,
		str	arg2
	)

Save the current status of the referenced content back to disk.

Python Docstring:

BakeRefEditToFile( (FBFileReference)arg1, (str)arg2) -> bool

C++ Signature:

bool BakeRefEditToFile(const char * pFilePath = ((void *) 0))

If pFilePath is ReferenceFilePath, we're saving all the modification back to the original referenced file. Otherwise, we will export the referenced file plus modification to another file.

Parameters

pFilePath File path to export.

Returns: true if successful.

See the C++ reference

bool ClearAllRefEdit ( FBFileReference arg1 )

Clear all cached Ref edit.

Python Docstring:

ClearAllRefEdit( (FBFileReference)arg1) -> bool

C++ Signature:

bool ClearAllRefEdit()

Returns: True if the RefEdits are cleared properly.

See the C++ reference

bool ClearRefEdit	(	FBFileReference	arg1,
		str	arg2
	)

Clear the cached RefEdit for the given ref file path.

Python Docstring:

ClearRefEdit( (FBFileReference)arg1, (str)arg2) -> bool

C++ Signature:

bool ClearRefEdit(const char * pFilePath)

Parameters

pFilePath The Ref File Path to query against, default to be current Ref File.

Returns: True if the RefEdit for the given Ref File Path is cached and cleared properly.

See the C++ reference

bool DuplicateFileRef	(	FBFileReference	arg1,
		FBStringList	arg2,
		object	arg3
	)

Duplicate/Clone the FileRef object and its referenced content (with/without refEdit).

Python Docstring:

DuplicateFileRef( (FBFileReference)arg1, (FBStringList)arg2 [, (object)arg3]) -> bool

C++ Signature:

bool DuplicateFileRef(const ORSDK2018::FBStringList & pDstNameSpaceList, bool pWithRefEdit = false)

Parameters

pDstNameSpaceList	the list of target new namespace(s) for duplication. These new namespace(s) must be residing in editable scene segments.
pWithRefEdit	false by default, duplication won't include the existing ref edit. otherwise ref edit will be applied on the instantiated FileRef in someway.

Returns: true if successful, false is fail.

See the C++ reference

FBDelete ( FBFileReference arg1 )

Python Docstring:

FBDelete( (FBFileReference)arg1) -> None

str GetRefEdit	(	FBFileReference	arg1,
		str	arg2
	)

Return the RefEdit for given RefFile Path.

Python Docstring:

GetRefEdit( (FBFileReference)arg1 [, (str)arg2]) -> str

C++ Signature:

const char * GetRefEdit(const char * pFilePath = ((void *) 0))

Parameters

pFilePath The Ref File Path to query against, default to be current Ref File.

Returns: RefEdit as string

See the C++ reference

GetRefFileList	(	FBFileReference	arg1,
		FBStringList	arg2
	)

Return a list of ref file path which has cached Ref Edit.

Python Docstring:

GetRefFileList( (FBFileReference)arg1, (FBStringList)arg2) -> None

C++ Signature:

void GetRefFileList(ORSDK2018::FBStringList & pRefFileList)

Parameters

pRefFileList the output parameter to collect the Ref File Path.

See the C++ reference

RevertRefEdit	(	FBFileReference	arg1,
		FBPlug	arg2,
		FBPlugModificationFlag	arg3
	)

Revert the modification on the referenced object/property to original state.

Python Docstring:

RevertRefEdit( (FBFileReference)arg1 [, (FBPlug)arg2 [, (FBPlugModificationFlag)arg3]]) -> None

C++ Signature:

void RevertRefEdit(ORSDK2018::FBPlug * pPlug = ((void *) 0), FBPlugModificationFlag pModificationFlag = kFBAllModifiedMask)

Parameters

pPlug	the plug to revert, revert all if NULL.
pModificationFlag	the modification type to revert.

See the C++ reference

bool SwapReferenceFilePath	(	FBFileReference	arg1,
		str	arg2,
		object	arg3,
		object	arg4
	)

Swap the Ref File Path and apply ref edit.

Python Docstring:

SwapReferenceFilePath( (FBFileReference)arg1, (str)arg2, (object)arg3, (object)arg4) -> bool

C++ Signature:

bool SwapReferenceFilePath(const char * pFilePath, bool pApplyAvailableRefEdit = true, bool pMergeCurrentRefEdit = true)

Parameters

pFilePath	The new Ref File path to be used
pApplyAvailableRefEdit	Apply the cached Ref Edit (if exist) for the Ref File to be used if True.
pMergeCurrentRefEdit	Merge the current RefEdit to if True if the reference items' name are matching.

Returns: True if swap successfully.

See the C++ reference

Member Data Documentation

FBPropertyBool IsLoaded

Read Write Property: File Reference Load/Unload.

See the C++ reference

ORSDK2018::FBPropertyString ReferenceFilePath

Read Write Property: File Reference file path.

See the C++ reference

FBFileReference Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation