Python Reference Guide
 
Loading...
Searching...
No Matches
FBGroup Class Reference

Objects Grouping class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBGroup:

Public Member Functions

 FBGroup (str pName)
 Constructor.
 
FBGroup Clone ()
 Clone the group.
 
bool Contains (FBComponent pComponent)
 Contains.
 
 FBDelete ()
 Virtual FBDelete function.
 
 Select (bool pSelect)
 Select.
 
- Public Member Functions inherited from FBBox
 FBBox (str pName)
 Constructor.
 
bool AnimationNodeDestroy (FBAnimationNode pAnimationNode)
 Destroy an animation node.
 
FBAnimationNode AnimationNodeInGet ()
 Get the (IN/OUT) animation node for this box.
 
bool AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
 Is the animation node user data?
 
FBAnimationNode AnimationNodeOutGet ()
 
str FbxGetObjectSubType ()
 Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
 
str FbxGetObjectType ()
 Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
 
FBAnimationNode GetInConnector (int pIndex)
 Get the animation node input associated with the given index.
 
int GetInConnectorCount ()
 Get the number of animation node inputs for this box.
 
FBAnimationNode GetOutConnector (int pIndex)
 Get the animation node output associated with the given index.
 
int GetOutConnectorCount ()
 Get the number of animation node outputs for this box.
 
- 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

FBListComponent Items
 List: Items in the group.

 
bool Pickable
 Read Write Property: Controls if objects in the group are pickable.

 
bool Show
 Read Write Property: Controls if objects in the group are displayed.

 
bool Transformable
 Read Write Property: Controls if objects in the group are transformable.

 
- Public Attributes inherited from FBBox
bool Animatable
 Read Write Property: Is the box animatable.

 
bool Live
 Read Write Property: Is live?

 
bool RecordMode
 Read Write Property: Is recording?

 
str UniqueName
 internal Unique name.

 
- 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 Grouping class.


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

See samples: FBGetSelectedModels.py, FBGroup.py.

Constructor & Destructor Documentation

◆ FBGroup()

FBGroup ( str  pName)

Constructor.

Parameters
pNameGroup name.

Member Function Documentation

◆ Clone()

FBGroup Clone ( )

Clone the group.

This will duplicated the current group.

Returns
Newly created group.

◆ Contains()

bool Contains ( FBComponent  pComponent)

Contains.

Parameters
pComponentComponent to verify if it is in the Group
Returns
True if the object is in the Group

◆ FBDelete()

FBDelete ( )

Virtual FBDelete function.

See sample: DeleteHierarchy.py.

◆ Select()

Select ( bool  pSelect)

Select.

Parameters
pSelectIf true, group contents will be selected.

Member Data Documentation

◆ Items

FBListComponent Items

List: Items in the group.

◆ Pickable

bool Pickable

Read Write Property: Controls if objects in the group are pickable.

◆ Show

bool Show

Read Write Property: Controls if objects in the group are displayed.

◆ Transformable

bool Transformable

Read Write Property: Controls if objects in the group are transformable.