Device optical marker. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBDeviceOpticalMarker:

[legend]

Public Member Functions
	FBDeviceOpticalMarker (str pName)
	Constructor.

	SetData (float pX, float pY, float pZ=0.0, float pOcclusion=0.0)
	Set data for optical marker.

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	IsUsed
	Property: Is marker used?

FBModel	Model
	Property: Model marker access.

float	Occlusion
	Property: Occulsion data for marker.

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

Device optical marker.

A device optical marker represents the input locations for interfacing optical hardware. This type of marker corresponds uniquely to the input (from the hardware) and will be represented on-screen by a FBModelMarkerOptical.

Constructor & Destructor Documentation

◆ FBDeviceOpticalMarker()

FBDeviceOpticalMarker ( str pName )

Constructor.

Parameters

pName Name of optical marker.

Member Function Documentation

◆ SetData()

SetData	(	float	pX,
		float	pY,
		float	pZ = `0.0`,
		float	pOcclusion = `0.0`
	)

Set data for optical marker.

Parameters

pX	X position for marker.
pY	Y position for marker.
pZ	Z position for marker(default=0.0).
pOcclusion	Occulsion information for marker(default=0.0).

Member Data Documentation

◆ IsUsed

bool IsUsed

Property: Is marker used?

◆ Model

FBModel Model

Property: Model marker access.

◆ Occlusion

float Occlusion

Property: Occulsion data for marker.

Public Member Functions

Public Attributes