FBFileReference Class Reference

Objects Containing class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBFileReference:

Public Member Functions
	FBFileReference (str pSingleLevelNamespace, FBNamespace pParentNSObj)
	Constructor.
	ApplyRefEditPyScriptFromFile (str pRefEditPyScriptFilePath)
	Apply specified reference edits from python script file.
	ApplyRefEditPyScriptFromString (str pRefEditPyScript)
	Apply specified reference edits from Python script string.
bool	BakeRefEditToFile (str pFilePath=None)
	Save the current status of the referenced content back to disk.
bool	ClearAllRefEdit ()
	Clear all cached Ref edit.
bool	ClearRefEdit (str pFilePath)
	Clear the cached RefEdit for the given ref file path.
bool	DuplicateFileRef (FBStringList pDstNameSpaceList, bool pWithRefEdit=False)
	Duplicate/Clone the FileRef object and its referenced content (with/without refEdit).
str	GetRefEdit (str pFilePath=None)
	Return the RefEdit for given RefFile Path.
	GetRefFileList (FBStringList pRefFileList)
	Return a list of ref file path which has cached Ref Edit.
	RevertRefEdit (FBPlug pPlug=None, FBPlugModificationFlag pModificationFlag=kFBAllModifiedMask)
	Revert the modification on the referenced object/property to original state.
bool	SwapReferenceFilePath (str pFilePath, bool pApplyAvailableRefEdit=True, bool pMergeCurrentRefEdit=True)
	Swap the Ref File Path and apply ref edit.
Public Member Functions inherited from FBNamespace
	FBNamespace (str pSingleLevelNamespace, FBNamespace pParentNSObj)
	Constructor.
FBComponent	GetContent (int pIndex)
	Get the namespace content object count (Not Recursive).
int	GetContentCount ()
	Get the namespace content objects count (Not Recursive).
	GetContentList (FBComponentList pContentList, FBPlugModificationFlag pModificationFlags=kFBPlugAllContent, bool pRecursive=True, int pTypeInfo=FBPlug::TypeInfo, bool pExactTypeMatch=False)
	Get List of the namespace content.
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
bool	IsLoaded
	Read Write Property: File Reference Load/Unload.
str	ReferenceFilePath
	Read Write Property: File Reference file path.
Public Attributes inherited from FBNamespace
FBListNamespace	ChildrenNamespaces
	List: Direct Children Namespace Objects.
bool	ContentLocked
	Read Write Property: Content locking state.
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

Objects Containing class.

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

See sample: MBFileRefDemo.py.

Constructor & Destructor Documentation

FBFileReference()

FBFileReference	(	str	pSingleLevelNamespace,
		FBNamespace	pParentNSObj
	)

Constructor.

Create a new direct children FileReference object

Parameters

pSingleLevelNamespace	FileReference name. This name will be used as namespace itself. this name string shouldn't contain namespace string separator ":".
pParentNSObj	the parent namespace object. if NULl means to create top level namespace.

Member Function Documentation

ApplyRefEditPyScriptFromFile()

ApplyRefEditPyScriptFromFile

(

str

pRefEditPyScriptFilePath

)

Apply specified reference edits from python script file.

Parameters

pRefEditPyScriptFilePath

Reference edits Python script file path.

ApplyRefEditPyScriptFromString()

ApplyRefEditPyScriptFromString

(

str

pRefEditPyScript

)

Apply specified reference edits from Python script string.

Parameters

pRefEditPyScript

Reference edits Python script.

BakeRefEditToFile()

bool BakeRefEditToFile

(

str

pFilePath = None

)

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

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.

ClearAllRefEdit()

bool ClearAllRefEdit

(

)

Clear all cached Ref edit.

Returns

True if the RefEdits are cleared properly.

ClearRefEdit()

bool ClearRefEdit

(

str

pFilePath

)

Clear the cached RefEdit for the given ref file path.

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.

DuplicateFileRef()

bool DuplicateFileRef	(	FBStringList	pDstNameSpaceList,
		bool	pWithRefEdit = False
	)

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

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.

GetRefEdit()

str GetRefEdit

(

str

pFilePath = None

)

Return the RefEdit for given RefFile Path.

Parameters

pFilePath

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

Returns

RefEdit as string

GetRefFileList()

GetRefFileList

(

FBStringList

pRefFileList

)

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

Parameters

pRefFileList

the output parameter to collect the Ref File Path.

RevertRefEdit()

RevertRefEdit	(	FBPlug	pPlug = None,
		FBPlugModificationFlag	pModificationFlag = kFBAllModifiedMask
	)

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

Parameters

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

SwapReferenceFilePath()

bool SwapReferenceFilePath	(	str	pFilePath,
		bool	pApplyAvailableRefEdit = True,
		bool	pMergeCurrentRefEdit = True
	)

Swap the Ref File Path and apply ref edit.

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.

Member Data Documentation

IsLoaded

bool IsLoaded

Read Write Property: File Reference Load/Unload.

ReferenceFilePath

str ReferenceFilePath

Read Write Property: File Reference file path.