Progress bar.b>Property: Base property class. More...

#include <pyfbsdk.h>

Inheritance diagram for FBProgress:

[legend]

Public Member Functions
	FBProgress ()
	Constructor.

	ProgressBegin ()
	Start progress, must be called before set Text & Percent property.

	ProgressDone ()
	End progress, must be called to reset progress bar UI to normal status after finishing the task.

bool	UserRequestCancell ()
	Return true if User is pressing and holding "ESC" key to request the cancellation.

Public Member Functions inherited from FBVisualComponent
	FBVisualComponent ()
	Constructor.

bool	AddChild (FBVisualComponent pChild, int pId=0)
	Add a child component.

FBVisualComponent	GetChild (int pId=0)
	Get a child component.

QWidget	GetQWidgetAddress ()
	Get internal QWidget.

bool	IsView ()
	Is component a view?

	Refresh (bool pNow=False)
	Refresh component.

	ViewExpose ()
	Exposed view callback function.

	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function.

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
str	Caption
	Read Write Property: Caption to be displayed for progress bar.

int	Percent
	Read Write Property: Percent completed for the operation. Must be used called in between ProgressBegin()/ProgressDone()

str	Text
	Read Write Property: Text to display on progress bar. Must be used in between ProgressBegin()/ProgressDone()

Public Attributes inherited from FBVisualComponent
str	RegionName
	Read Write Property: Region name.

int	RegionOffsetX
	Read Write Property: Region X offset.

int	RegionOffsetY
	Read Write Property: Region Y offset.

int	RegionOffsetWidth
	Read Write Property: Region width offset.

int	RegionOffsetHeight
	Read Write Property: Region height offset.

float	RegionRatioX
	Read Write Property: Ratio for X attachment.

float	RegionRatioY
	Read Write Property: Ratio for Y attachment.

float	RegionRatioWidth
	Read Write Property: Ratio for Width attachment.

float	RegionRatioHeight
	Read Write Property: Ratio for Height attachment.

FBAttachType	RegionAttachTypeX
	Read Write Property: X Attachment type.

FBAttachType	RegionAttachTypeY
	Read Write Property: Y Attachment type.

FBAttachType	RegionAttachTypeWidth
	Read Write Property: Width Attachment type.

FBAttachType	RegionAttachTypeHeight
	Read Write Property: Height Attachment type.

FBVisualComponent	RegionAttachToX
	Read Write Property X Attachment source.

FBVisualComponent	RegionAttachToY
	Read Write Property: Y Attachment source.

FBVisualComponent	RegionAttachToWidth
	Read Write Property: Width Attachment source.

FBVisualComponent	RegionAttachToHeight
	Read Write Property: Height Attachment source.

int	RegionPosMaxX
	Read Write Property: Region X position Max

int	RegionPosMinX
	Read Write Property: Region X position Min

int	RegionPosMaxY
	Read Write Property: Region Y position Max

int	RegionPosMinY
	Read Write Property: Region Y position Min

str	BorderCaption
	Read Write Property: Caption to display in border.

bool	BorderShowCaption
	Read Write Property: Show caption?

FBBorderStyle	BorderStyle
	Read Write Property: Style of border.

bool	BorderInSet
	Read Write Property: Is border inset?

int	BorderWidth
	Read Write Property: Width of border.

int	BorderSpacing
	Read Write Property: Spacing of border.

float	BorderMaxAngle
	Read Write Property: Max angle for rounding.

int	BorderCornerRadius
	Read Write Property: Corner radius (rounded).

str	Caption
	Property: Widget caption.

bool	Enabled
	Read Write Property: Is visual enabled?

int	Height
	Read Write Property: Height.

str	Hint
	Read Write Property: Hint to show.

int	Left
	Read Write Property: Left coordinate.

bool	ReadOnly
	Read Write Property: Is visual component read only?

int	Top
	Read Write Property: Top coordinate.

bool	Visible
	Read Write Property: Is visual component visible?

int	Width
	Read Write Property: Width.

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

Progress bar.b>Property: Base property class.

See samples: 3dsMaxBipedTemplate.py, MirrorPoseOverTime.py, FBProgress.py.
A property is a holder for function callbacks into the internals of the application.You cannot instantiate FBProperty objects. To reference a property: Use an instance of an FBComponent object. The methods FBComponent::PropertyCreate and FBComponent::PropertyRemove can be used to modify an object's set of properties. When accessing a FBProperty object via its containing object, you can get or set (assuming it is not read-only) its value directly, for example in Python: myObject.Visibility = True. FBPropertyManager exists in all FBComponent objects, and contains an array of all the registered properties. Use FBProperty::Find to find a property by name. When accessing a property reference directly, its value is obtained via its 'Data' member.

myProp = myObject.PropertyList.Find( 'Visibility' )

if myProp: myProp.Data = True

To see how to create a custom property in Python, see CustomProperty.py.

See samples: CustomProperty.py, SetAllToDoneInAllTakes.py.

Constructor & Destructor Documentation

◆ FBProgress()

FBProgress ( )

Constructor.

Member Function Documentation

◆ ProgressBegin()

ProgressBegin ( )

Start progress, must be called before set Text & Percent property.

◆ ProgressDone()

ProgressDone ( )

End progress, must be called to reset progress bar UI to normal status after finishing the task.

◆ UserRequestCancell()

bool UserRequestCancell ( )

Return true if User is pressing and holding "ESC" key to request the cancellation.

Must be called in between ProgressBegin()/ProgressDone().

Member Data Documentation

◆ Caption

str Caption

Read Write Property: Caption to be displayed for progress bar.

◆ Percent

int Percent

Read Write Property: Percent completed for the operation. Must be used called in between ProgressBegin()/ProgressDone()

◆ Text

str Text

Read Write Property: Text to display on progress bar. Must be used in between ProgressBegin()/ProgressDone()

Public Member Functions

Public Attributes