FBDeviceOptical Class Reference

Optical device class. More...

#include <pyfbsdk_generated.h>

Inheritance diagram for FBDeviceOptical:

Public Member Functions
	FBDeviceOptical (str pName)
	Constructor.
	DeviceOpticalBeginSetup ()
	Begin device setup.
	DeviceOpticalEndSetup ()
	End device setup.
	DeviceOpticalRecordFrame (FBTime pTime, FBDeviceNotifyInfo pDeviceNotifyInfo)
	Record a frame of information from device.
bool	FBCreate ()
	Open Reality Creation function.
	FBDestroy ()
	Open Reality destruction function.
	RecordingDoneAnimation (FBAnimationNode pAnimationNode)
	When recording, finish animation.
	RecordingInitAnimation (FBAnimationNode pAnimationNode)
	When recording, initialize animation.
Public Member Functions inherited from FBDevice
	FBDevice (str pName)
	Constructor.
	AckOneBadSampleReceived ()
	Acknowlege that one bad sample was received (for statistical purposes).
	AckOneSampleReceived ()
	Acknowlege that one sample was received (for statistical purposes).
	AckOneSampleSent ()
	Acknowlege that one sample was sent (for statistical purposes).
bool	DeviceOperation (kDeviceOperations pOperation)
	Operate device.
	DeviceSendCommand (kDeviceOperations pOperation)
	Send a command to the device.
bool	FBCreate ()
	Open Reality Creation function.
	FBDestroy ()
	Open Reality destruction function.
FBModel	ModelBindingCreate ()
	Create a new model binding.
	ModelBindingRootsList (FBModelList pList)
	Get the list of all the possible root models for binding.
	RecordingDoneAnimation (FBAnimationNode pAnimationNode)
	When recording, finish animation.
	RecordingInitAnimation (FBAnimationNode pAnimationNode)
	When recording, initialize animation.
Public Member Functions inherited from FBBox
	FBBox (str pName)
	Constructor.
bool	AnimationNodeDestroy (FBAnimationNode pAnimationNode)
	Destroy an animation node.
FBAnimationNode	AnimationNodeInGet ()
	Get the (IN/OUT) animation node for this box.
bool	AnimationNodeIsUserData (FBAnimationNode pAnimationNode)
	Is the animation node user data?
FBAnimationNode	AnimationNodeOutGet ()
str	FbxGetObjectSubType ()
	Returns the class sub type inherited by the class of an object, for example: 'Relations', 'Parent-Child', 'Number to Vector', 'Shot'.
str	FbxGetObjectType ()
	Returns the class type inherited by the class of an object, for example: 'Box', 'Constraint', 'TimelineXTrack'.
FBAnimationNode	GetInConnector (int pIndex)
	Get the animation node input associated with the given index.
int	GetInConnectorCount ()
	Get the number of animation node inputs for this box.
FBAnimationNode	GetOutConnector (int pIndex)
	Get the animation node output associated with the given index.
int	GetOutConnectorCount ()
	Get the number of animation node outputs for this box.
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	AutoAntialiasing
	Property: Is it auto-antialiasing?
float	DampingTime
	Property: Damping time for device.
bool	ForceOpticalSamplingRate
	Property: Force the use of the optical sampling rate?
FBTime	MarkerTimeStamp
	Property: TimeStamp for marker.
FBListDeviceOpticalMarker	Markers
	List: Markers.
FBModel	ModelOptical
	Property: Optical model for manipulation.
float	OpticalSamplingRate
	Property: Resampling rate for optical device.
bool	SkipFrame
	Property: Skip Record Frame
bool	SupportOcclusion
	Property: Does the device support occulsion?
bool	UseMarkerTimeStamp
	Property: Use the individual marker timestamps?
Public Attributes inherited from FBDevice
int	CommType
	Read Write Property: Type of communications.
str	HardwareVersionInfo
	Read Write Property: Device information: hardware version.
str	Information
	Read Write Property: Device information: information.
FBModel	ModelBindingRoot
	Component: Root of model currently binded model hierarchy.
FBModelTemplate	ModelTemplate
	Component: Root of model template structure.
bool	Online
	Read Write Property: Is online?
FBTime	RecordingStartTime
	Read Only Property: The time at which the recording started.
FBTime	RecordingStopTime
	Read Only Property: The time at which the recording stopped.
FBDeviceSamplingMode	SamplingMode
	Read Write Property: Mode to use to record device.
FBTime	SamplingPeriod
	Read Write Property: Set this to how many times a device is to be evaluated in one second. There is no theoretical maximum value but practically you should consider scene complexity, system resources, network speed, etc. If set to 0: the device is evaluated on the sync signal. When the sync occurs; the device is scheduled to be evaluated. If you do not set, the sampling period is based on the internal variable from the [Sync] section of the .Application.txt file (NTSC, PAL, CINEMA).
str	Status
	Read Write Property: Device information: status.
Public Attributes inherited from FBBox
bool	Animatable
	Read Write Property: Is the box animatable.
bool	Live
	Read Write Property: Is live?
bool	RecordMode
	Read Write Property: Is recording?
str	UniqueName
	internal Unique name.
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

Optical device class.

Constructor & Destructor Documentation

FBDeviceOptical()

FBDeviceOptical

(

str

pName

)

Constructor.

Parameters

pName

Unique name of optical device.

Member Function Documentation

DeviceOpticalBeginSetup()

DeviceOpticalBeginSetup

(

)

Begin device setup.

DeviceOpticalEndSetup()

DeviceOpticalEndSetup

(

)

End device setup.

DeviceOpticalRecordFrame()

DeviceOpticalRecordFrame	(	FBTime	pTime,
		FBDeviceNotifyInfo	pDeviceNotifyInfo
	)

Record a frame of information from device.

Virtual function that derived class may overide

Parameters

pTime	Time of evaluation.
pDeviceNotifyInfo	Notification information when thread was called.

FBCreate()

bool FBCreate

(

)

Open Reality Creation function.

Returns

Outcome of creation (true/false).

FBDestroy()

FBDestroy

(

)

Open Reality destruction function.

RecordingDoneAnimation()

RecordingDoneAnimation

(

FBAnimationNode

pAnimationNode

)

When recording, finish animation.

Parameters

pAnimationNode

Animation node to write information to.

RecordingInitAnimation()

RecordingInitAnimation

(

FBAnimationNode

pAnimationNode

)

When recording, initialize animation.

Parameters

pAnimationNode

Animation node to read information from.

Member Data Documentation

AutoAntialiasing

bool AutoAntialiasing

Property: Is it auto-antialiasing?

DampingTime

float DampingTime

Property: Damping time for device.

ForceOpticalSamplingRate

bool ForceOpticalSamplingRate

Property: Force the use of the optical sampling rate?

Markers

FBListDeviceOpticalMarker Markers

List: Markers.

MarkerTimeStamp

FBTime MarkerTimeStamp

Property: TimeStamp for marker.

ModelOptical

FBModel ModelOptical

Property: Optical model for manipulation.

OpticalSamplingRate

float OpticalSamplingRate

Property: Resampling rate for optical device.

SkipFrame

bool SkipFrame

Property: Skip Record Frame

SupportOcclusion

bool SupportOcclusion

Property: Does the device support occulsion?

UseMarkerTimeStamp

bool UseMarkerTimeStamp

Property: Use the individual marker timestamps?