Visual3D Game Engine API Documentation for XNA, C#, VB, and .NET

Holds the current Dynamics state for an object (it's velocity and acceleration).

Namespace: Visual3D.Physics
Assembly: Visual3D.Engine (in Visual3D.Engine.dll) Version: 1.0.0.0 (1.0.0.0)

Syntax


	C#			Visual Basic

[SerializableAttribute]
public class YawPitchRollPhysicsBody : SimplePhysicsBody

<SerializableAttribute> _
Public Class YawPitchRollPhysicsBody _
	Inherits SimplePhysicsBody

Members

All Members

Constructors Public method

Fields

Properties Public property

Methods

Events

 Public

 Protected
 Instance

 Static 
 Declared

 Inherited
 XNA Framework Only 

 .NET Compact Framework Only 

	Member	Description
	YawPitchRollPhysicsBody()()()()	Initializes a new instance of the YawPitchRollPhysicsBody class
	YawPitchRollPhysicsBody(SceneObject, MotionType, Single, Single, Single, Boolean)	Initializes a new instance of the YawPitchRollPhysicsBody class
	YawPitchRollPhysicsBody(SceneObject, MotionType, LinearDamping, LinearDamping, Single, Boolean)	Initializes a new instance of the YawPitchRollPhysicsBody class
	AddAcceleration(Acceleration)	Applies the specified Acceleration to this Body (until manually removed). (Inherited from SimplePhysicsBody.)
	AddAngularAcceleration(Acceleration..::..Angular)	Applies the specified Acceleration to this Body (until manually removed). (Inherited from SimplePhysicsBody.)
	AddAngularVelocity(Single, Vector3, TransformSpace)	Add Interval Spin with specified relativity. (Inherited from SimplePhysicsBody.)
	AddIntervalAngularVelocity(Single, Vector3, TransformSpace)	Add Interval Spin with specified relativity. (Inherited from SimplePhysicsBody.)
	AddLinearAcceleration(Acceleration..::..Linear)	Applies the specified Acceleration to this Body (until manually removed). (Inherited from SimplePhysicsBody.)
	AddYPRAcceleration(Acceleration..::..YPR)	(Inherited from SimplePhysicsBody.)
	AngularAcceleration	(Inherited from SimplePhysicsBody.)
	AngularDamping	Angular Damping factor, sets the effective "linear drag" of this body causing the velocity to decay proportionately to it's magnitude. (Inherited from SimplePhysicsBody.)
	AngularDampingDelay	Indicates Spin Damping should be delayed for XX update intervals. Usually set whenever Spin rate is Manually adjusted. (Inherited from SimplePhysicsBody.)
	AngularDampingTime	Amount of time it should take for Body to decay to 1% of it's current angular velocity. (Inherited from SimplePhysicsBody.)
	AngularFactor	(Inherited from SimplePhysicsBody.)
	AngularVelocity	(Inherited from SimplePhysicsBody.)
	ApplyAngularImpulse(Single, Vector3, TransformSpace)	(Inherited from SimplePhysicsBody.)
	ApplyCentralForce(Vector3)	(Inherited from SimplePhysicsBody.)
	ApplyCentralImpulse(Vector3)	(Inherited from SimplePhysicsBody.)
	ApplyForce(Vector3, Vector3)	(Inherited from SimplePhysicsBody.)
	ApplyImpulse(Vector3, Vector3)	(Inherited from SimplePhysicsBody.)
	ApplyLinearImpulse(Vector3, TransformSpace)	(Inherited from SimplePhysicsBody.)
	ApplyPitchImpulse(Single)	(Overrides SimplePhysicsBody..::..ApplyPitchImpulse(Single).)
	ApplyRollImpulse(Single)	(Overrides SimplePhysicsBody..::..ApplyRollImpulse(Single).)
	ApplyTorque(Vector3)	(Inherited from SimplePhysicsBody.)
	ApplyTorqueImpulse(Vector3)	(Inherited from SimplePhysicsBody.)
	ApplyWorldYawImpulse(Single)	Adds to the Fixed-Axis Yaw Rate. (Overrides SimplePhysicsBody..::..ApplyWorldYawImpulse(Single).)
	ApplyYawImpulse(Single)	Adds to the Interval Yaw Rate. (Overrides SimplePhysicsBody..::..ApplyYawImpulse(Single).)
	BodyOffset	(Inherited from SimplePhysicsBody.)
	Bounces	(Inherited from SimplePhysicsBody.)
	BuoyancyFactor	(Inherited from SimplePhysicsBody.)
	CaptureBaselineYaw()()()()	(Overrides SimplePhysicsBody..::..CaptureBaselineYaw()()()().)
	CaptureBaselineYawPitch()()()()	(Overrides SimplePhysicsBody..::..CaptureBaselineYawPitch()()()().)
	CaptureBaselineYPROrientation()()()()	Resets the Yaw/Pitch/Roll fields. (Overrides SimplePhysicsBody..::..CaptureBaselineYPROrientation()()()().)
	CcdSquareMotionThreshold	(Inherited from SimplePhysicsBody.)
	CenterOfMassPosition	(Inherited from SimplePhysicsBody.)
	CopyEvents(SimplePhysicsBody)	Part of upgrading from SimplePhysicsBody to YawPitchRollPhysicsBody. (Inherited from SimplePhysicsBody.)
	CreateCopy(SceneObject)	(Inherited from SimplePhysicsBody.)
	DebugHandle	(Inherited from SimplePhysicsBody.)
	DefaultAngularDamping	Second-based Multiplier used for standard Spin Damping (multiplied every second). (Inherited from SimplePhysicsBody.)
	DefaultAngularFallDamping	Second-based Multiplier used for standard Spin Damping while Falling (multiplied every second). (Inherited from SimplePhysicsBody.)
	DefaultLinearDamping	Second-based Multiplier used for standard Velocity Damping (multiplied every second). (Inherited from SimplePhysicsBody.)
	DefaultLinearFallDamping	Second-based Multiplier used for standard Velocity Damping while Falling (multiplied every second). (Inherited from SimplePhysicsBody.)
	Dispose()()()()	(Inherited from SimplePhysicsBody.)
	Friction	(Inherited from SimplePhysicsBody.)
	GetOrientation()()()()	(Inherited from SimplePhysicsBody.)
	GetWorldOrigin()()()()	(Inherited from SimplePhysicsBody.)
	Gravity	(Inherited from SimplePhysicsBody.)
	GravityScale	Indicates the relative gravitational pull on this object when it leaves the ground. Note: 1f => Normal, and 0 => Weightless. (Inherited from SimplePhysicsBody.)
	HasContactResponse	(Inherited from SimplePhysicsBody.)
	HasLinearAcceleration	(Inherited from SimplePhysicsBody.)
	HasOwner	(Inherited from SimplePhysicsBody.)
	IntervalLinearVelocity	World-Aligned Positional offset that will occur for each DynamicMgr Interval Update. (Inherited from SimplePhysicsBody.)
	IsActive	(Inherited from SimplePhysicsBody.)
	IsDisposed	(Inherited from SimplePhysicsBody.)
	IsFalling	Gets/Sets if object is falling (being acclerated by gravity). (Inherited from SimplePhysicsBody.)
	IsInWorld	(Inherited from SimplePhysicsBody.)
	IsKinematicObject	(Inherited from SimplePhysicsBody.)
	IsLinearVelocityRotated	Indicates if the linear and spin velocities are rotated along with the body such that their relative values are preserved when the body is rotated. NOTE: If True, this gives the "TrainTrack" effect, as momentum follows the turning tracks. (Inherited from SimplePhysicsBody.)
	IsMotionLevel	Indicates if level motion of the object is to be preserved on rotations (i.e. don't rotate motion into Y-axis). (Inherited from SimplePhysicsBody.)
	IsPhysicBodyOffset	(Inherited from SimplePhysicsBody.)
	IsSleeping	(Inherited from SimplePhysicsBody.)
	IsStaticObject	(Inherited from SimplePhysicsBody.)
	IsStationary	Indicates if Object is World-Aligned Stationary (i.e. not Moving, Spinning or Accelerated). (Inherited from SimplePhysicsBody.)
	IsTouchingGroundSurface	(Inherited from SimplePhysicsBody.)
	IsTrulyFalling	(Inherited from SimplePhysicsBody.)
	IsWorldYawAxis	Gets/sets if Yaw rotation axis is always aligned with the World Y Axis.
	LastHeightAboveGround	(Inherited from SimplePhysicsBody.)
	LinearAcceleration	(Inherited from SimplePhysicsBody.)
	LinearDamping	Linear Damping factor, sets the effective "linear drag" of this body causing the velocity to decay proportionately to it's magnitude. (Inherited from SimplePhysicsBody.)
	LinearDampingDelay	Indicates Linear Damping should be delayed for XX update intervals. Usually set whenever Velocity is Manually adjusted. (Inherited from SimplePhysicsBody.)
	LinearDampingTime	Amount of time it should take for Body to decay to 1% of it's current linear velocity. (Inherited from SimplePhysicsBody.)
	LinearVelocity	Linear velocity body (units/second). (Inherited from SimplePhysicsBody.)
	LocalInertia	(Inherited from SimplePhysicsBody.)
	LocalIntervalAngularVelocity	Interval Spin Relative to Local Transform Space for this node. (Inherited from SimplePhysicsBody.)
	LocalIntervalVelocity	Interval Velocity Relative to Local Transform Space for this node. (Inherited from SimplePhysicsBody.)
	ManualSpin	True when angular motion is being applied manually over time. This is needed, so that physics won't think motion is stopping, which causes CaptureBaselineYPROrientation. (Inherited from SimplePhysicsBody.)
	Mass	(Inherited from SimplePhysicsBody.)
	MotionStarted	Event that fires when Dynamic Motion of this node begins. (Inherited from SimplePhysicsBody.)
	MotionStopped	(Inherited from SimplePhysicsBody.)
	MotionType	Nature of the Dynamics Implementation. (Inherited from SimplePhysicsBody.)
	Name	(Inherited from SimplePhysicsBody.)
	NotifyParentObjectMoved()()()()	(Inherited from SimplePhysicsBody.)
	NotifyParentObjectRotated()()()()	(Inherited from SimplePhysicsBody.)
	Orientation	(Inherited from SimplePhysicsBody.)
	ParentObject	(Inherited from SimplePhysicsBody.)
	PhysicsSettings	(Inherited from SimplePhysicsBody.)
	PhysicsSystem	(Inherited from SimplePhysicsBody.)
	PI
	Pitch	Current Pitch Value relative to Initial Orientation when Motion started. (Overrides SimplePhysicsBody..::..Pitch.)
	PitchDamping
	PitchDegrees	Current Pitch Value relative to Initial Orientation when Motion started. (Overrides SimplePhysicsBody..::..PitchDegrees.)
	PitchMax
	PitchMin
	PitchRate	Indicates the current Pitch rotational rate (radians/sec).
	Position	(Inherited from SimplePhysicsBody.)
	RADIANS_PER_DEGREE
	RaiseMotionStoppedEvent()()()()	Event that fires anytime this SceneObject stops moving. (Inherited from SimplePhysicsBody.)
	RaiseMovedEvent()()()()	Event that fires anytime this SceneObject is moved or rotated. (Inherited from SimplePhysicsBody.)
	RaiseRotatedEvent()()()()	Event that fires anytime this Dynamic causes the controlled node to be rotated. (Inherited from SimplePhysicsBody.)
	RelativeBodyPositionOffset	(Inherited from SimplePhysicsBody.)
	RelativeBodyRotationalOffset	(Inherited from SimplePhysicsBody.)
	RemoveAcceleration(Acceleration)	Removes an acceleration from the Body that was previously added. (Inherited from SimplePhysicsBody.)
	RemoveAllAccelerations()()()()	(Inherited from SimplePhysicsBody.)
	RemoveAngularAcceleration(Acceleration..::..Angular)	Removes a Spin Acceleration from the Body that was previously added. (Inherited from SimplePhysicsBody.)
	RemoveLinearAcceleration(Acceleration..::..Linear)	Removes a Linear Acceleration from the Body that was previously added. (Inherited from SimplePhysicsBody.)
	RemoveYPRAcceleration(Acceleration..::..YPR)	(Inherited from SimplePhysicsBody.)
	ResetToBaselineYPROrientation()()()()	(Overrides SimplePhysicsBody..::..ResetToBaselineYPROrientation()()()().)
	Restitution	(Inherited from SimplePhysicsBody.)
	Roll	Current Roll Value relative to Initial Orientation when Motion started. (Overrides SimplePhysicsBody..::..Roll.)
	RollDamping
	RollDegrees	Current Roll Value relative to Initial Orientation when Motion started. (Overrides SimplePhysicsBody..::..RollDegrees.)
	RollRate	Indicates the current Roll rotational rate (radians/sec).
	RotatePitch(Single)	(Inherited from SimplePhysicsBody.)
	RotateRoll(Single)	(Inherited from SimplePhysicsBody.)
	RotateYaw(Single)	(Overrides SimplePhysicsBody..::..RotateYaw(Single).)
	Rotation	(Overrides SimplePhysicsBody..::..Rotation.)
	SetDamping(Single, Single)	(Inherited from SimplePhysicsBody.)
	SetOrientation(Quaternion)	(Inherited from SimplePhysicsBody.)
	SetOrientationWithoutEvents(Quaternion)	(Inherited from SimplePhysicsBody.)
	SetOrigin(Vector3)	(Inherited from SimplePhysicsBody.)
	SnapPositionToParentObjectWithoutEvents()()()()	(Inherited from SimplePhysicsBody.)
	Speed	(Inherited from SimplePhysicsBody.)
	States	Indicates the dynamic states currently possessed by this body - having to do with the current dimensions of motion that need to be updated. (Inherited from SimplePhysicsBody.)
	StopMotion()()()()	Resets Motion to Zero, and Initializes the States/ActivityFlags. (Overrides SimplePhysicsBody..::..StopMotion()()()().)
	ToString()()()()	(Inherited from SimplePhysicsBody.)
	Translate(Vector3)	(Inherited from SimplePhysicsBody.)
	TrueFallingHeight	(Inherited from SimplePhysicsBody.)
	UpdateAccelerations()()()()	Should be called if any of the applied Accelerations are altered, to tell this body to recalculate the total acceleration applied to it. (Inherited from SimplePhysicsBody.)
	UpdateAngularAccelerations()()()()	Update the Spin Acceleration Summation acting on this Body. (Overrides SimplePhysicsBody..::..UpdateAngularAccelerations()()()().)
	UpdateDynamicState()()()()	Call this every XXX frames to update the Dynamic State which will evaluate the types of updates that should be done for this body. (Inherited from SimplePhysicsBody.)
	UpdateLinearAccelerations()()()()	Update the Linear Acceleration Summation acting on this Body. (Inherited from SimplePhysicsBody.)
	UpdateMotion()()()()	Moves the body, then applies Damping and Accelerations to the motion. (Inherited from SimplePhysicsBody.)
	UpgradeSimplePhysicsBody(SimplePhysicsBody, SceneObject)
	UseAABBMinYHeight	(Inherited from SimplePhysicsBody.)
	WorldMatrix	(Inherited from SimplePhysicsBody.)
	Yaw	Current Yaw Value relative to Initial Orientation when Motion started. (Overrides SimplePhysicsBody..::..Yaw.)
	YawDamping
	YawDegrees	Current Yaw Value relative to Initial Orientation when Motion started. (Overrides SimplePhysicsBody..::..YawDegrees.)
	YawRate	Indicates the current Yaw rotational rate (radians/sec).

Remarks

Interval Damping and Accelerations are the underlying efficient fields that are stored with this class, to facilitate quick FrameInterval math (everything is updated each interval, so therefore, it is more efficient to keep the raw fields in terms of Interval values.

Inheritance Hierarchy

System..::..Object
Visual3D.Physics..::..SimplePhysicsBody
Visual3D.Physics..::..YawPitchRollPhysicsBody

Syntax

Members

Remarks

Inheritance Hierarchy

See Also