FBView Class Reference

Generic view. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBView:

Public Member Functions
	FBView ()
	Constructor.
	DrawString (str pText, float pX, float pY, int pEnable=-1)
	Draw a string in the view.
bool	IsView ()
	Checks if object is a view.
	Refresh (bool pNow=False)
	Refresh view.
bool	SetViewport (int pX, int pY, int pW, int pH)
	Set view's viewport.
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
bool	DoubleBuffer
	Read Only Property: Indicates if the view is double buffered.
bool	GraphicOGL
	Read Only Property: Indicates if the view is OpenGL.
Public Attributes inherited from FBVisualComponent
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

Generic view.

Constructor & Destructor Documentation

FBView()

FBView

(

)

Constructor.

Member Function Documentation

DrawString()

DrawString	(	str	pText,
		float	pX,
		float	pY,
		int	pEnable = -1
	)

Draw a string in the view.

Parameters

pText	Text to draw.
pX	X position of string.
pY	Y position of string.
pEnable	Is string enabled? (default =-1)

IsView()

bool IsView

(

)

Checks if object is a view.

Returns

Is object a view? (true or false)

Refresh()

Refresh

(

bool

pNow = False

)

Refresh view.

Parameters

pNow	If true, refresh immediately (default = false).

SetViewport()

bool SetViewport	(	int	pX,
		int	pY,
		int	pW,
		int	pH
	)

Set view's viewport.

Parameters

pX	Viewport X value.
pY	Viewport Y value.
pW	Viewport W (width) value.
pH	Viewport H (height) value.

Returns

Operation was successful (true or false).

Member Data Documentation

DoubleBuffer

bool DoubleBuffer

Read Only Property: Indicates if the view is double buffered.

GraphicOGL

bool GraphicOGL

Read Only Property: Indicates if the view is OpenGL.