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

Manipulator class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBManipulator:

Public Member Functions

 FBManipulator (str pName)
 Constructor.
 
- 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 Active
 Read Write Property: Is manipulator active?

 
bool AlwaysActive
 Read Write Property: Is manipulator always active?

 
bool ConsumeEvent
 Read Write Property: Is manipulator consuming event? If true, this will prevent other manipulators from being called.

 
bool DefaultBehavior
 Read Write Property: Using default manipulator behavior?

 
str ViewerText
 Read Write Property: Text displayed in view.

 
bool Visible
 Read Write Property: Is manipulator visible?

 
- 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

Manipulator class.


Constructor & Destructor Documentation

◆ FBManipulator()

FBManipulator ( str  pName)

Constructor.

Parameters
pNameName of manipulator.

Member Data Documentation

◆ Active

bool Active

Read Write Property: Is manipulator active?

◆ AlwaysActive

bool AlwaysActive

Read Write Property: Is manipulator always active?

◆ ConsumeEvent

bool ConsumeEvent

Read Write Property: Is manipulator consuming event? If true, this will prevent other manipulators from being called.

◆ DefaultBehavior

bool DefaultBehavior

Read Write Property: Using default manipulator behavior?

◆ ViewerText

str ViewerText

Read Write Property: Text displayed in view.

◆ Visible

bool Visible

Read Write Property: Is manipulator visible?