RigidBodyTrackingSource
Properties
actionOnTrackingLost : int
Action to carry out if tracking is lost for any reason
Options: {0: ‘Maintain Last Known Values’, 1: ‘Reset’, 2: ‘Follow Sequencing’}
Category: On Tracking Lost/ Regained
UserName: Action On Tracking Lost
calibrated : int
Options: {0: ‘NotCalibrated’, 1: ‘Calibrated’}
Category: Rigid Body
UserName: Status
constrainXYZEnabled : Vec
Limiting motion in XYZ dimensions (0 = off, 1 = on)
Category: Constraints
UserName: Constraints XYZ Enabled
constrainXYZRotEnabled : Vec
Limiting motion in XYZ orientations (0 = off, 1 = on)
Category: Constraints
UserName: Constraints XYZ Rotation Enabled
constraintXYZMax : Vec
Limit in the +XYZ Axes (m)
Category: Constraints
UserName: Constraint XYZ Max
constraintXYZMin : Vec
Limit in the -XYZ Axes (m)
Category: Constraints
UserName: Constraint XYZ Min
constraintXYZRotMax : Vec
Limit the +XYZ Rotation (deg)
Category: Constraints
UserName: Constraint XYZ Max Rotation
constraintXYZRotMin : Vec
Limit the -XYZ Rotation (deg)
Category: Constraints
UserName: Constraint XYZ Min Rotation
engaged : int
Options: {0: ‘No’, 1: ‘Yes’}
Category: Rigid Body
UserName: Engaged
fixed : List[ReferencePoint]
isPositionApproximationEnabled : int
With this option enabled the RigidBody solver will attempt to track position (excluding any rotation) if there are 1 or 2 points visible. Note: only valid for the RigidBody solver, which requires 3 visible tracked points for a full solve of position and rotation.
Options: {0: ‘Off’, 1: ‘On’}
Category: On Tracking Lost/ Regained
UserName: Position Approximation
nSolverIterations : int
Number of iterations to improve base solved pose.
Category: Rigid Body
UserName: Solver iterations
offset : Vec
Set a tweak offset. Only active when receiving tracking data
Category: Tweak
UserName: Offset
offsets : List[Vec]
posThreshold : float
Set this to a value greater than zero to prevent Dynamic Blend from recomputing because of static oscillation
Category: Rigid Body
UserName: Movement threshold (mm/frame)
resetPosition : Vec
Stage position to return to in ‘Reset’ mode
Category: On Tracking Lost/ Regained
UserName: Reset Position
resetRotation : Vec
Stage Orientation to return to in ‘Reset’ mode
Category: On Tracking Lost/ Regained
UserName: Reset Rotation
rotation : Vec
Set a tweak rotation. Only active when receiving tracking data
Category: Tweak
UserName: Rotation
rotationThreshold : float
Set this to a value greater than zero to prevent Dynamic Blend from recomputing because of static oscillation
Category: Rigid Body
UserName: Rotation threshold (deg/frame)
samplingSnapFixedPoints : bool (Read-Only)
smoothingFactorSolvedOffset : float
UserName: Solver smooothing factor (%)
solverMode : int
The RigidBody solver requires 3 visible tracked points for a full solve of position and rotation. The Actor solver will only solve for position and requires at least 1 visible tracked point.
Options: {0: ‘RigidBody’, 1: ‘Actor’}
Category: Rigid Body
UserName: Solver mode
tpReceiveTimeoutSecs : float
Tracked point receive timeout after N seconds. Applies to all tracked points for rigid body.
Category: Tracked Point Timeouts
UserName: Receive Timeout (sec)
tpReceivingForThresholdSecs : float
Tracked point receiving with confidence threshold after N seconds. Applies to all tracked points for rigid body.
Category: Tracked Point Timeouts
UserName: Confidence Threshold (sec)
tpStoppedReceivingForThresholdSecs : float
Tracked point remove from stage after N seconds. Applies to all tracked points for rigid body.
Category: Tracked Point Timeouts
UserName: Remove from Stage Timeout (sec)
tracked : List[TrackedPoint]
trackingLostTimeout : float
How long to wait after tracking loss before executing the action
Category: On Tracking Lost/ Regained
UserName: On Tracking Lost Timeout (sec)
trackingRegainedAnimationDuration : float
Duration of animating position to tracked position when tracking is regained
Category: On Tracking Lost/ Regained
UserName: On Tracking Regained Animation Duration (sec)
Methods
addPair(self)
removePair(self)
showBtMarkers(self, onOff: bool)
snapButtonDisabledReason(self) -> str
The reason why the ‘Calibrate’ button is currently disabled. Returns empty String if it’s enabled.