Objects Containing class. More...

#include <fbfilereference.h>

Inheritance diagram for FBFileReference:

[legend]

Public Member Functions
	FBFileReference (const char pSingleLevelNamespace, FBNamespace pParentNSObj)
	Constructor.

bool	BakeRefEditToFile (const char *pFilePath=NULL)
	Save the current status of the referenced content back to disk.

void	RevertRefEdit (FBPlug *pPlug=NULL, FBPlugModificationFlag pModificationFlag=kFBAllModifiedMask)
	Revert the modification on the referenced object/property to original state.

void	ApplyRefEditPyScriptFromFile (const char *pRefEditPyScriptFilePath)
	Apply specified reference edits from python script file.

void	ApplyRefEditPyScriptFromString (const char *pRefEditPyScript)
	Apply specified reference edits from Python script string.

bool	DuplicateFileRef (const FBStringList &pDstNameSpaceList, bool pWithRefEdit=false)
	Duplicate/Clone the FileRef object and its referenced content (with/without refEdit).

const char *	GetRefEdit (const char *pFilePath=NULL)
	Return the RefEdit for given RefFile Path.

bool	ClearRefEdit (const char *pFilePath)
	Clear the cached RefEdit for the given ref file path.

bool	ClearAllRefEdit ()
	Clear all cached Ref edit.

bool	SwapReferenceFilePath (const char *pFilePath, bool pApplyAvailableRefEdit=true, bool pMergeCurrentRefEdit=true)
	Swap the Ref File Path and apply ref edit.

void	GetRefFileList (FBStringList &pRefFileList) const
	Return a list of ref file path which has cached Ref Edit.

Public Member Functions inherited from FBNamespace
	FBNamespace (const char pSingleLevelNamespace, FBNamespace pParentNSObj)
	Constructor.

int	GetContentCount () const
	Get the namespace content objects count (Not Recursive).

FBComponent *	GetContent (int pIndex) const
	Get the namespace content object count (Not Recursive).

void	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 (HIObject pObject)
	Constructor.

virtual	~FBComponent ()
	Destructor.

virtual bool	FBCreate ()
	Open Reality Creation function.

virtual void	FBDestroy ()
	Open Reality destruction function.

virtual void	FBDelete () override
	Open Reality deletion function.

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer.

virtual 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.

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager.

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading.

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property.

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated).

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags.

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled.

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags.

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags.

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status.

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled.

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy.

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace.

virtual const char *	ClassName () override
	Get the class name.

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not.

const char *	GetFullName (void)
	Get the full name.

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object.

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object.

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object.

void	HardSelect ()
	HardSelect.

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId.

virtual int	GetTypeId () override
	GetTypeId( int pTypeId )

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject.

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyString	ReferenceFilePath
	Read Write Property: File Reference file path.

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

Public Attributes inherited from FBNamespace
FBPropertyListNamespace	ChildrenNamespaces
	List: Direct Children Namespace Objects.

FBPropertyBool	ContentLocked
	Read Write Property: Content locking state.

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component.

FBPropertyListComponent	Components
	List: List of components.

FBPropertyListComponent	Parents
	List: Parents.

FBPropertyBool	Selected
	Read Write Property: Selected property.

FBPropertyString	Name
	Read Write Property: Unique name of object.

FBPropertyString	LongName
	Read Write Property: Name and namespace for object.

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component.

Protected Member Functions
	FBFileReference (const char *pMultiLevelNamespace, HIObject pObject)
	Constructor.

Protected Member Functions inherited from FBNamespace
	FBNamespace (const char *pMultiLevelNamespace, HIObject pObject)
	Constructor.

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component.

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection.

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection.

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection.

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection.

void	DisconnectAllSrc ()
	Remove all source connections.

void	DisconnectAllDst ()
	Remove all destination connections.

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index.

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index.

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index.

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index.

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B.

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex.

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc.

int	GetSrcCount ()
	Get source connection count.

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index.

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index.

int	GetDstCount ()
	Get destination connection count.

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index.

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index.

bool	BeginChange ()
	Begins a change on multiple plugs.

void	EndChange ()
	Ends a change on multiple plugs.

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag.

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed.

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag.

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed.

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List.

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status.

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag.

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed.

FBPlug *	GetOwner ()
	Get the owner of this plug.

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index.

int	GetOwnedCount ()
	Get the owned plug count.

virtual const char *	ClassName ()
	internal System vars.

virtual bool	Is (int pTypeId)
	Is( int pTypeId )

virtual int	GetTypeId ()
	GetTypeId( int pTypeId )

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only.

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only.

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only.

virtual void	FBDelete ()
	Actual destructor for a FBPlug.

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object.

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id.

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component.

HIObject	mObject
	Handle on the Plug.

bool	mSDKComponent
	bool Plug is an SDK component.

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object.

static int	TypeInfo
	TypeInfo.

static int	mGlobalTypeInfo
	Represente the Type Index.

Detailed Description

Objects Containing class.

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

Definition at line 86 of file fbfilereference.h.

Constructor & Destructor Documentation

◆ FBFileReference() [1/2]

FBFileReference	(	const char *	pMultiLevelNamespace,
		HIObject	pObject
	)

protected

Constructor.

For internal use only.

Parameters

pMultiLevelNamespace	FileReference name. This name will be used as namespace itself. it should follow such pattern "NS1[:NS2[:NS3]]]", where content inside [] is optional
pObject	For internal use only.

◆ FBFileReference() [2/2]

FBFileReference	(	const char *	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()

void ApplyRefEditPyScriptFromFile ( const char * pRefEditPyScriptFilePath )

Apply specified reference edits from python script file.

Parameters

pRefEditPyScriptFilePath Reference edits Python script file path.

◆ ApplyRefEditPyScriptFromString()

void ApplyRefEditPyScriptFromString ( const char * pRefEditPyScript )

Apply specified reference edits from Python script string.

Parameters

pRefEditPyScript Reference edits Python script.

◆ BakeRefEditToFile()

bool BakeRefEditToFile ( const char * pFilePath = NULL )

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 ( const char * 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	(	const 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()

const char * GetRefEdit ( const char * pFilePath = NULL )

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()

void GetRefFileList ( FBStringList & pRefFileList ) const

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

Parameters

pRefFileList the output parameter to collect the Ref File Path.

◆ RevertRefEdit()

void RevertRefEdit	(	FBPlug *	pPlug = `NULL`,
		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	(	const char *	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

FBPropertyBool IsLoaded

Read Write Property: File Reference Load/Unload.

Definition at line 112 of file fbfilereference.h.

◆ ReferenceFilePath

FBPropertyString ReferenceFilePath

Read Write Property: File Reference file path.

Definition at line 111 of file fbfilereference.h.

The documentation for this class was generated from the following file:

fbfilereference.h

Public Member Functions

Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBFileReference() [1/2]

◆ FBFileReference() [2/2]

Member Function Documentation

◆ ApplyRefEditPyScriptFromFile()

◆ ApplyRefEditPyScriptFromString()

◆ BakeRefEditToFile()

◆ ClearAllRefEdit()

◆ ClearRefEdit()

◆ DuplicateFileRef()

◆ GetRefEdit()

◆ GetRefFileList()

◆ RevertRefEdit()

◆ SwapReferenceFilePath()

Member Data Documentation

◆ IsLoaded

◆ ReferenceFilePath