CryEngine.EntitySystem.PhysicsObject

Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members

Representation of an object in the physics engine More...

Inherited by CryEngine.EntitySystem.PhysicsEntity.

Public Member Functions
void	SetVelocity (Vector3 velocity)
	Set the velocity of this PhysicsObject. More...

void	AddImpulse (Vector3 impulse)
	Adds an impulse to this PhysicsObject. More...

void	AddImpulse (Vector3 impulse, Vector3 point)
	Adds an impulse to this PhysicsObject. The impulse will be applied to the point in world-space. More...

void	Move (Vector3 direction)
	Move this PhysicsObject in a direction. More...

void	Jump (Vector3 direction)
	Move this PhysicsObject in a direction, but apply the velocity instantly. More...

void	Action< T > (Action< T > setParams)
	Adds and executes a physics action of type T. More...

T	GetStatus< T > ()

Protected Member Functions
void	SetType (pe_type nativeType)

Protected Attributes
Entity	_entity

Properties
PhysicalizationType	PhysicsType = PhysicalizationType.None `[get, set]`
	The physicalized type of this PhysicsObject. If the PhysicsObject is not physicalized this will be `PhysicalizationType.None`. More...

virtual Entity	OwnerEntity `[get]`
	Gets the Entity that this PhysicsObject belongs to. More...

Vector3	Velocity `[get, set]`
	Get or set the velocity of this PhysicsObject. More...

Vector3	AngularVelocity `[get, set]`
	Get or set the angular velocity of this PhysicsObject. More...

Vector3	LinearAcceleration `[get]`
	The acceleration that is currently being applied to this PhysicsObject. More...

Vector3	AngularAcceleration `[get]`
	The angular acceleration that is currently being applied to this PhysicsObject. More...

Vector3	Impulse `[set]`
	Adds an impulse to this PhysicsObject. More...

Detailed Description

Representation of an object in the physics engine

Member Function Documentation

◆ Action< T >()

void CryEngine.EntitySystem.PhysicsObject.Action< T >

(

Action< T >

setParams

)

inline

Adds and executes a physics action of type T.

Template Parameters

Parameters

setParams

Sets the parameters of the action to be performed.

Type Constraints

pe_action

◆ AddImpulse() [1/2]

void CryEngine.EntitySystem.PhysicsObject.AddImpulse

(

Vector3

impulse

)

inline

Adds an impulse to this PhysicsObject.

Parameters

impulse

Direction and length of the impulse.

◆ AddImpulse() [2/2]

void CryEngine.EntitySystem.PhysicsObject.AddImpulse	(	Vector3	impulse,
		Vector3	point
	)

inline

Adds an impulse to this PhysicsObject. The impulse will be applied to the point in world-space.

Parameters

impulse	Direction and length of the impulse.
point	Point of application, in world-space.

◆ GetStatus< T >()

T CryEngine.EntitySystem.PhysicsObject.GetStatus< T >

(

)

inline

Type Constraints

T	:	BasePhysicsStatus
T	:	new()

◆ Jump()

void CryEngine.EntitySystem.PhysicsObject.Jump

(

Vector3

direction

)

inline

Move this PhysicsObject in a direction, but apply the velocity instantly.

Parameters

direction

◆ Move()

void CryEngine.EntitySystem.PhysicsObject.Move

(

Vector3

direction

)

inline

Move this PhysicsObject in a direction.

Parameters

direction

◆ SetType()

void CryEngine.EntitySystem.PhysicsObject.SetType

(

pe_type

nativeType

)

inline

protected

◆ SetVelocity()

void CryEngine.EntitySystem.PhysicsObject.SetVelocity

(

Vector3

velocity

)

inline

Set the velocity of this PhysicsObject.

Parameters

velocity

Member Data Documentation

◆ _entity

Entity CryEngine.EntitySystem.PhysicsObject._entity

protected

Property Documentation

◆ AngularAcceleration

Vector3 CryEngine.EntitySystem.PhysicsObject.AngularAcceleration

get

The angular acceleration that is currently being applied to this PhysicsObject.

The angular acceleration.

◆ AngularVelocity

Vector3 CryEngine.EntitySystem.PhysicsObject.AngularVelocity

get

set

Get or set the angular velocity of this PhysicsObject.

The angular velocity.

◆ Impulse

Vector3 CryEngine.EntitySystem.PhysicsObject.Impulse

set

Adds an impulse to this PhysicsObject.

◆ LinearAcceleration

Vector3 CryEngine.EntitySystem.PhysicsObject.LinearAcceleration

get

The acceleration that is currently being applied to this PhysicsObject.

The linear acceleration.

◆ OwnerEntity

virtual Entity CryEngine.EntitySystem.PhysicsObject.OwnerEntity

get

Gets the Entity that this PhysicsObject belongs to.

◆ PhysicsType

PhysicalizationType CryEngine.EntitySystem.PhysicsObject.PhysicsType = PhysicalizationType.None

get

set

The physicalized type of this PhysicsObject. If the PhysicsObject is not physicalized this will be PhysicalizationType.None.

The physicalized type of the PhysicsObject.

◆ Velocity

Vector3 CryEngine.EntitySystem.PhysicsObject.Velocity

get

set

Get or set the velocity of this PhysicsObject.