FalcoEngine.Rigidbody Class Reference

Inheritance diagram for FalcoEngine.Rigidbody:

Public Member Functions
void	AddForce (Vector3 force)
	Adds a force to the rigidbody More...
void	AddForce (Vector3 force, Vector3 rel_pos)
	Adds a force to the rigidbody relative to its coordinate system More...
void	AddTorque (Vector3 torque)
	Adds a torque to the rigidbody More...
void	SetFreezePosition (bool freezeX, bool freezeY, bool freezeZ)
	Controls whether physics will change the position of the object More...
void	SetFreezeRotation (bool freezeX, bool freezeY, bool freezeZ)
	Controls whether physics will change the rotation of the object More...

Properties
Vector3	position [getset]
	The position of the rigidbody More...
Quaternion	rotation [getset]
	The rotation of the rigidbody More...
Vector3	linearVelocity [getset]
	The velocity vector of the rigidbody It represents the rate of change of rigidbody position More...
Vector3	angularVelocity [getset]
	The angular velocity vector of the rigidbody measured in radians per second More...
float	friction [getset]
	The friction of an object Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving More...
float	bounciness [getset]
	How bouncy is the surface? A value of 0 will not bounce A value of 1 will bounce without any loss of energy, certain approximations are to be expected though that might add small amounts of energy to the simulation More...
float	linearDamping [getset]
	The drag of the object More...
float	angularDamping [getset]
	The angular drag of the object More...
bool	isKinematic [getset]
	Controls whether physics affects the rigidbody More...
bool	isStatic [getset]
	Static objects behave like a wall or a floor which can only affect the other objects and not moving More...
bool	isTrigger [get]
	Is the collider a trigger? A trigger doesn't register a collision with an incoming rigidbody Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume. More...
float	mass [getset]
	The mass of the rigidbody More...
Properties inherited from FalcoEngine.Component
bool	enabled [getset]
	Enable or disable this component More...
GameObject	gameObject [get]
	Get game object at which this component is attached More...
bool	isUiComponent [get]
	Returns if this component is derived from UIElement (or this is a canvas) or not More...

Additional Inherited Members
Protected Member Functions inherited from FalcoEngine.Component
	Component ()

Detailed Description

Definition at line 7 of file Rigidbody.cs.

Member Function Documentation

AddForce() [1/2]

void FalcoEngine.Rigidbody.AddForce

(

Vector3

force

)

Adds a force to the rigidbody

Parameters

force

Definition at line 150 of file Rigidbody.cs.

AddForce() [2/2]

void FalcoEngine.Rigidbody.AddForce	(	Vector3	force,
		Vector3	rel_pos
	)

Adds a force to the rigidbody relative to its coordinate system

Parameters

force
rel_pos

Definition at line 160 of file Rigidbody.cs.

AddTorque()

void FalcoEngine.Rigidbody.AddTorque

(

Vector3

torque

)

Adds a torque to the rigidbody

Parameters

torque

Definition at line 169 of file Rigidbody.cs.

SetFreezePosition()

void FalcoEngine.Rigidbody.SetFreezePosition	(	bool	freezeX,
		bool	freezeY,
		bool	freezeZ
	)

Controls whether physics will change the position of the object

Parameters

freezeX
freezeY
freezeZ

SetFreezeRotation()

void FalcoEngine.Rigidbody.SetFreezeRotation	(	bool	freezeX,
		bool	freezeY,
		bool	freezeZ
	)

Controls whether physics will change the rotation of the object

Parameters

freezeX
freezeY
freezeZ

Property Documentation

angularDamping

float FalcoEngine.Rigidbody.angularDamping

getset

The angular drag of the object

Definition at line 102 of file Rigidbody.cs.

angularVelocity

Vector3 FalcoEngine.Rigidbody.angularVelocity

getset

The angular velocity vector of the rigidbody measured in radians per second

Definition at line 68 of file Rigidbody.cs.

bounciness

float FalcoEngine.Rigidbody.bounciness

getset

How bouncy is the surface? A value of 0 will not bounce A value of 1 will bounce without any loss of energy, certain approximations are to be expected though that might add small amounts of energy to the simulation

Definition at line 92 of file Rigidbody.cs.

friction

float FalcoEngine.Rigidbody.friction

getset

The friction of an object Usually a value from 0 to 1. A value of zero feels like ice, a value of 1 will make it very hard to get the object moving

Definition at line 85 of file Rigidbody.cs.

isKinematic

bool FalcoEngine.Rigidbody.isKinematic

getset

Controls whether physics affects the rigidbody

Definition at line 107 of file Rigidbody.cs.

isStatic

bool FalcoEngine.Rigidbody.isStatic

getset

Static objects behave like a wall or a floor which can only affect the other objects and not moving

Definition at line 122 of file Rigidbody.cs.

isTrigger

bool FalcoEngine.Rigidbody.isTrigger

get

Is the collider a trigger? A trigger doesn't register a collision with an incoming rigidbody Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.

Definition at line 129 of file Rigidbody.cs.

linearDamping

float FalcoEngine.Rigidbody.linearDamping

getset

The drag of the object

Definition at line 97 of file Rigidbody.cs.

linearVelocity

Vector3 FalcoEngine.Rigidbody.linearVelocity

getset

The velocity vector of the rigidbody It represents the rate of change of rigidbody position

Definition at line 52 of file Rigidbody.cs.

mass

float FalcoEngine.Rigidbody.mass

getset

The mass of the rigidbody

Definition at line 134 of file Rigidbody.cs.

position

Vector3 FalcoEngine.Rigidbody.position

getset

The position of the rigidbody

Definition at line 19 of file Rigidbody.cs.

rotation

Quaternion FalcoEngine.Rigidbody.rotation

getset

The rotation of the rigidbody

Definition at line 35 of file Rigidbody.cs.

---

The documentation for this class was generated from the following file:

• API/Components/Physics/Rigidbody.cs