#include <mobu-python-api.h>

Class Description

Visual Component base class.

All of the user interface elements available in the SDK derive from this class.

Inheritance diagram for FBVisualComponent:

Public Member Functions
	__reduce__ ()

bool	AddChild (FBVisualComponent arg1, FBVisualComponent arg2, object arg3)
	Add a child component. More...

object	GetChild (FBVisualComponent arg1, object arg2)
	Get a child component. More...

bool	IsView (FBVisualComponent arg1)
	Is component a view? More...

	Refresh (FBVisualComponent arg1, object arg2)
	Refresh component. More...

	ViewExpose (FBVisualComponent arg1)
	Exposed view callback function. More...

	ViewInput (FBVisualComponent arg1, object arg2, object arg3, FBInputType arg4, object arg5, object arg6)
	Input callback function. More...

int	GetQWidgetAddress (FBVisualComponent arg1)
	Get internal QWidget. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBComponent
	__reduce__ ()

FBPropertyList	PropertyGetModifiedList (FBComponent arg1, FBPlugModificationFlag arg2)
	Get list of properties which have been modified since last loading. More...

str	ClassName (FBComponent arg1)
	Get the class name. More...

	DisableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Disable a specific Object Flags. More...

	EnableObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Enable a specific Object Flags. More...

bool	FBCreate (FBComponent arg1)
	Open Reality Creation function. More...

	FBDelete (FBComponent arg1)
	Open Reality deletion function. More...

	FBDestroy (FBComponent arg1)
	Open Reality destruction function. More...

FBObjectFlag	GetObjectFlags (FBComponent arg1)
	Get all Object Flags (concatenated). More...

bool	GetObjectStatus (FBComponent arg1, FBObjectStatus arg2)
	Check to see if an object status is enabled. More...

bool	HasObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	Check whether a specific object flag is enabled. More...

bool	Is (FBComponent arg1, object arg2)
	Returns true if object is of type TypeId. More...

bool	ProcessNamespaceHierarchy (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBComponent arg1, FBNamespaceAction arg2, str arg3, str arg4, object arg5)
	ProcessObjectNamespace. More...

int	PropertyAdd (FBComponent arg1, FBProperty arg2)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBComponent arg1, FBProperty arg2)
	Add a reference property to the component's property manager. More...

object	PropertyCreate (FBComponent arg1, str arg2, FBPropertyType arg3, str arg4, object arg5, object arg6, FBProperty arg7)
	Create user or dynamic property. More...

	PropertyRemove (FBComponent arg1, FBProperty arg2)
	Remove a Property from the component's Property manager. More...

	SetObjectFlags (FBComponent arg1, FBObjectFlag arg2)
	SetObjectFlags. More...

	SetObjectStatus (FBComponent arg1, FBObjectStatus arg2, object arg3)
	Enable/Disable a specific Object Status. More...

	HardSelect (FBComponent arg1)
	HardSelect. More...

object	GetOwnerFileReference (FBComponent arg1)
	Get the owner FileReference object. More...

	__init__ (...)
	Constructor. More...

Public Member Functions inherited from FBPlug
	__reduce__ ()

bool	BeginChange (FBPlug arg1)
	Begins a change on multiple plugs. More...

str	ClassName (FBPlug arg1)
	internal System vars. More...

bool	ConnectDst (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a destination connection. More...

bool	ConnectDstAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a destination connection. More...

bool	ConnectSrc (FBPlug arg1, FBPlug arg2, FBConnectionType arg3)
	Add a source connection. More...

bool	ConnectSrcAt (FBPlug arg1, object arg2, FBPlug arg3, FBConnectionType arg4)
	Add a source connection. More...

	DisconnectAllDst (FBPlug arg1)
	Remove all destination connections. More...

	DisconnectAllSrc (FBPlug arg1)
	Remove all source connections. More...

bool	DisconnectDst (FBPlug arg1, FBPlug arg2)
	Remove a destination connection. More...

bool	DisconnectDstAt (FBPlug arg1, object arg2)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrc (FBPlug arg1, FBPlug arg2)
	Remove a source connection. More...

bool	DisconnectSrcAt (FBPlug arg1, object arg2)
	Remove a source connection at a specified index. More...

	EndChange (FBPlug arg1)
	Ends a change on multiple plugs. More...

object	GetDst (FBPlug arg1, object arg2)
	Get a destination connection's plug at specified index. More...

int	GetDstCount (FBPlug arg1)
	Get destination connection count. More...

FBConnectionType	GetDstType (FBPlug arg1, object arg2)
	Get a destination connection's type at specified index. More...

object	GetOwned (FBPlug arg1, object arg2)
	Get the owned plug at specified index. More...

int	GetOwnedCount (FBPlug arg1)
	Get the owned plug count. More...

object	GetOwner (FBPlug arg1)
	Get the owner of this plug. More...

object	GetSrc (FBPlug arg1, object arg2)
	Get a source connection's plug at specified index. More...

int	GetSrcCount (FBPlug arg1)
	Get source connection count. More...

FBConnectionType	GetSrcType (FBPlug arg1, object arg2)
	Get a source connection's type at specified index. More...

bool	Is (FBPlug arg1, object arg2)
	Is( int pTypeId ) More...

bool	IsSDKComponent (FBPlug arg1)
	Return whether or not item is an SDK component. More...

	MoveSrcAt (...)

bool	ReplaceDstAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (FBPlug arg1, object arg2, FBPlug arg3)
	Replace a source connection at a specified index. More...

bool	SwapSrc (FBPlug arg1, object arg2, object arg3)
	Swap source connection at index A with source connection at index B. More...

	SetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's self has changed. More...

	SetContentModified (FBPlug arg1, FBPlugModificationFlag arg2, object arg3)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlug arg1, FBPlugModificationFlag arg2)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlug arg1, FBPlugList arg2, FBPlugModificationFlag arg3, object arg4)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlug arg1, FBPlugModificationFlag arg2)
	Revert the plug's modification to original status. More...

	__init__ (...)

method	staticmethod (function)

Public Member Functions inherited from FBPythonWrapper
	__reduce__ ()

	__init__ (...)

Public Attributes
ORSDK2018::FBPropertyString	Caption
	Property: Widget caption. More...

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled? More...

ORSDK2018::FBPropertyString	Hint
	Read Write Property: Hint to show. More...

FBPropertyBool	ReadOnly
	Read Write Property: Is visual component read only? More...

FBPropertyBool	Visible
	Read Write Property: Is visual component visible? More...

FBPropertyInt	Left
	Read Write Property: Left coordinate. More...

FBPropertyInt	Top
	Read Write Property: Top coordinate. More...

FBPropertyInt	Width
	Read Write Property: Width. More...

FBPropertyInt	Height
	Read Write Property: Height. More...

object	RegionName

object	RegionOffsetX

object	RegionOffsetY

object	RegionOffsetWidth

object	RegionOffsetHeight

object	RegionRatioX

object	RegionRatioY

object	RegionRatioWidth

object	RegionRatioHeight

object	RegionAttachTypeX

object	RegionAttachTypeY

object	RegionAttachTypeWidth

object	RegionAttachTypeHeight

object	RegionAttachToX

object	RegionAttachToY

object	RegionAttachToWidth

object	RegionAttachToHeight

object	RegionPosMinX

object	RegionPosMaxX

object	RegionPosMinY

object	RegionPosMaxY

object	BorderCaption

object	BorderShowCaption

object	BorderStyle

object	BorderWidth

object	BorderSpacing

object	BorderInSet

object	BorderMaxAngle

object	BorderCornerRadius

Public Attributes inherited from FBComponent
object	OwnerNamespace

ORSDK2018::FBPropertyListComponent	Components
	List: List of components. More...

ORSDK2018::FBPropertyString	Name
	Read Write Property: Unique name of object. More...

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

object	FullName

ORSDK2018::FBPropertyListComponent	Parents
	List: Parents. More...

ORSDK2018::FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

Public Attributes inherited from FBPythonWrapper
object	OnUnbind

Member Function Documentation

__init__ ( ... )

Constructor.

Python Docstring:

Raises an exception
This class cannot be instantiated from Python

C++ Signature:

 FBVisualComponent(HIObject pObject)

See the C++ reference

__reduce__ ( )

bool AddChild	(	FBVisualComponent	arg1,
		FBVisualComponent	arg2,
		object	arg3
	)

Add a child component.

Python Docstring:

AddChild( (FBVisualComponent)arg1, (FBVisualComponent)arg2 [, (object)arg3]) -> bool

C++ Signature:

bool AddChild(ORSDK2018::FBVisualComponent * pChild, int pId = 0)

Parameters

pChild	Visual component to add as a child.
pId	User reference number to associate with pChild(default=0).

Returns: Operation was successful (true or false).

See the C++ reference

object GetChild	(	FBVisualComponent	arg1,
		object	arg2
	)

Get a child component.

Python Docstring:

GetChild( (FBVisualComponent)arg1, (object)arg2) -> object

C++ Signature:

ORSDK2018::FBVisualComponent * GetChild(int pId = 0)

Parameters

pId	User reference number to look for child with(default=0).

Returns: Handle to child (NULL if not found).

See the C++ reference

int GetQWidgetAddress ( FBVisualComponent arg1 )

Get internal QWidget.

Python Docstring:

GetQWidgetAddress( (FBVisualComponent)arg1) -> int

C++ Signature:

QWidget * GetQWidgetAddress()

Returns: Handle to internal QWidget object.

See the C++ reference

bool IsView ( FBVisualComponent arg1 )

Is component a view?

Python Docstring:

IsView( (FBVisualComponent)arg1) -> bool

C++ Signature:

bool IsView()

Returns: true if component is a view.

See the C++ reference

Refresh	(	FBVisualComponent	arg1,
		object	arg2
	)

Refresh component.

Python Docstring:

Refresh( (FBVisualComponent)arg1 [, (object)arg2]) -> None

C++ Signature:

void Refresh(bool pNow = false)

Parameters

pNow	Refresh immediately if true (default = false).

See the C++ reference

ViewExpose ( FBVisualComponent arg1 )

Exposed view callback function.

Python Docstring:

ViewExpose( (FBVisualComponent)arg1) -> None

C++ Signature:

void ViewExpose()

See the C++ reference

ViewInput	(	FBVisualComponent	arg1,
		object	arg2,
		object	arg3,
		FBInputType	arg4,
		object	arg5,
		object	arg6
	)

Input callback function.

Python Docstring:

ViewInput( (FBVisualComponent)arg1, (object)arg2, (object)arg3, (FBInputType)arg4, (object)arg5, (object)arg6) -> None

C++ Signature:

void ViewInput(int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)

Parameters

pMouseX	Mouse X position.
pMouseY	Mouse Y position.
pAction	Mouse action.
pButtonKey	Keyboard input.
pModifier	Keyboard input modifier.

See the C++ reference

Member Data Documentation

BorderCaption

Read Write Property: (str) Caption to display in border.

BorderCornerRadius

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

BorderInSet

Read Write Property: (bool) Is border inset?

BorderMaxAngle

Read Write Property: (float) Max angle for rounding.

BorderShowCaption

Read Write Property: (bool) Show caption?

BorderSpacing

Read Write Property: (int) Spacing of border.

BorderStyle

Read Write Property: (FBBorderStyle) Style of border.

BorderWidth

Read Write Property: (int) Width of border.

ORSDK2018::FBPropertyString Caption

Property: Widget caption.

See the C++ reference

FBPropertyBool Enabled

Read Write Property: Is visual enabled?

See the C++ reference

FBPropertyInt Height

Read Write Property: Height.

See the C++ reference

ORSDK2018::FBPropertyString Hint

Read Write Property: Hint to show.

See the C++ reference

FBPropertyInt Left

Read Write Property: Left coordinate.

See the C++ reference

FBPropertyBool ReadOnly

Read Write Property: Is visual component read only?

See the C++ reference

RegionAttachToHeight

Read Write Property: (FBVisualComponent) Height Attachment source.

RegionAttachToWidth

Read Write Property: (FBVisualComponent) Width Attachment source.

RegionAttachToX

Read Write Property (FBVisualComponent) X Attachment source.

RegionAttachToY

Read Write Property: (FBVisualComponent) Y Attachment source.

RegionAttachTypeHeight

Read Write Property: (FBAttachType) Height Attachment type.

RegionAttachTypeWidth

Read Write Property: (FBAttachType) Width Attachment type.

RegionAttachTypeX

Read Write Property: (FBAttachType) X Attachment type.

RegionAttachTypeY

Read Write Property: (FBAttachType) Y Attachment type.

RegionName

Read Write Property: (str) Region name.

RegionOffsetHeight

Read Write Property: (int) Region height offset.

RegionOffsetWidth

Read Write Property: (int) Region width offset.

RegionOffsetX

Read Write Property: (int) Region X offset.

RegionOffsetY

Read Write Property: (int) Region Y offset.

RegionPosMaxX

Read Write Property: (int) Region X position Max

RegionPosMaxY

Read Write Property: (int) Region Y position Max

RegionPosMinX

Read Write Property: (int) Region X position Min

RegionPosMinY

Read Write Property: (int) Region Y position Min

RegionRatioHeight

Read Write Property: (float) Ratio for Height attachment.

RegionRatioWidth

Read Write Property: (float) Ratio for Width attachment.

RegionRatioX

Read Write Property: (float) Ratio for X attachment.

RegionRatioY

Read Write Property: (float) Ratio for Y attachment.

FBPropertyInt Top

Read Write Property: Top coordinate.

See the C++ reference

FBPropertyBool Visible

Read Write Property: Is visual component visible?

See the C++ reference

FBPropertyInt Width

Read Write Property: Width.

See the C++ reference

FBVisualComponent Class Reference

Class Description

Public Member Functions

Public Attributes

Member Function Documentation

Member Data Documentation