Kinematic Character Controller
Public Member Functions | Public Attributes | Properties | List of all members
KinematicCharacterController.PhysicsMover Class Reference

Component that manages the movement of moving kinematic rigidbodies for proper interaction with characters More...

Inherits MonoBehaviour.

Public Member Functions

void ValidateData ()
 Handle validating all required values More...
 
void SetPosition (Vector3 position)
 Sets the mover's position directly More...
 
void SetRotation (Quaternion rotation)
 Sets the mover's rotation directly More...
 
void SetPositionAndRotation (Vector3 position, Quaternion rotation)
 Sets the mover's position and rotation directly More...
 
PhysicsMoverState GetState ()
 Returns all the state information of the mover that is pertinent for simulation More...
 
void ApplyState (PhysicsMoverState state)
 Applies a mover state instantly More...
 
void VelocityUpdate (float deltaTime)
 Caches velocity values based on deltatime and target position/rotations More...
 

Public Attributes

Rigidbody Rigidbody
 The mover's Rigidbody More...
 
bool MoveWithPhysics = true
 Determines if the platform moves with rigidbody.MovePosition (when true), or with rigidbody.position (when false) More...
 
IMoverController MoverController
 Index of this motor in KinematicCharacterSystem arrays More...
 
Vector3 LatestInterpolationPosition
 Remembers latest position in interpolation More...
 
Quaternion LatestInterpolationRotation
 Remembers latest rotation in interpolation More...
 
Vector3 PositionDeltaFromInterpolation
 The latest movement made by interpolation More...
 
Quaternion RotationDeltaFromInterpolation
 The latest rotation made by interpolation More...
 

Properties

int IndexInCharacterSystem [get, set]
 Index of this motor in KinematicCharacterSystem arrays More...
 
Vector3 InitialTickPosition [get, set]
 Remembers initial position before all simulation are done More...
 
Quaternion InitialTickRotation [get, set]
 Remembers initial rotation before all simulation are done More...
 
Transform Transform [get]
 The mover's Transform More...
 
Vector3 InitialSimulationPosition [get]
 The character's position before the movement calculations began More...
 
Quaternion InitialSimulationRotation [get]
 The character's rotation before the movement calculations began More...
 
Vector3 TransientPosition [get]
 The mover's rotation (always up-to-date during the character update phase) More...
 
Quaternion TransientRotation [get]
 The mover's rotation (always up-to-date during the character update phase) More...
 

Detailed Description

Component that manages the movement of moving kinematic rigidbodies for proper interaction with characters

Member Function Documentation

◆ ApplyState()

void KinematicCharacterController.PhysicsMover.ApplyState ( PhysicsMoverState  state)

Applies a mover state instantly

◆ GetState()

PhysicsMoverState KinematicCharacterController.PhysicsMover.GetState ( )

Returns all the state information of the mover that is pertinent for simulation

◆ SetPosition()

void KinematicCharacterController.PhysicsMover.SetPosition ( Vector3  position)

Sets the mover's position directly

◆ SetPositionAndRotation()

void KinematicCharacterController.PhysicsMover.SetPositionAndRotation ( Vector3  position,
Quaternion  rotation 
)

Sets the mover's position and rotation directly

◆ SetRotation()

void KinematicCharacterController.PhysicsMover.SetRotation ( Quaternion  rotation)

Sets the mover's rotation directly

◆ ValidateData()

void KinematicCharacterController.PhysicsMover.ValidateData ( )

Handle validating all required values

◆ VelocityUpdate()

void KinematicCharacterController.PhysicsMover.VelocityUpdate ( float  deltaTime)

Caches velocity values based on deltatime and target position/rotations

Member Data Documentation

◆ LatestInterpolationPosition

Vector3 KinematicCharacterController.PhysicsMover.LatestInterpolationPosition

Remembers latest position in interpolation

◆ LatestInterpolationRotation

Quaternion KinematicCharacterController.PhysicsMover.LatestInterpolationRotation

Remembers latest rotation in interpolation

◆ MoverController

IMoverController KinematicCharacterController.PhysicsMover.MoverController

Index of this motor in KinematicCharacterSystem arrays

◆ MoveWithPhysics

bool KinematicCharacterController.PhysicsMover.MoveWithPhysics = true

Determines if the platform moves with rigidbody.MovePosition (when true), or with rigidbody.position (when false)

◆ PositionDeltaFromInterpolation

Vector3 KinematicCharacterController.PhysicsMover.PositionDeltaFromInterpolation

The latest movement made by interpolation

◆ Rigidbody

Rigidbody KinematicCharacterController.PhysicsMover.Rigidbody

The mover's Rigidbody

◆ RotationDeltaFromInterpolation

Quaternion KinematicCharacterController.PhysicsMover.RotationDeltaFromInterpolation

The latest rotation made by interpolation

Property Documentation

◆ IndexInCharacterSystem

int KinematicCharacterController.PhysicsMover.IndexInCharacterSystem
getset

Index of this motor in KinematicCharacterSystem arrays

◆ InitialSimulationPosition

Vector3 KinematicCharacterController.PhysicsMover.InitialSimulationPosition
get

The character's position before the movement calculations began

◆ InitialSimulationRotation

Quaternion KinematicCharacterController.PhysicsMover.InitialSimulationRotation
get

The character's rotation before the movement calculations began

◆ InitialTickPosition

Vector3 KinematicCharacterController.PhysicsMover.InitialTickPosition
getset

Remembers initial position before all simulation are done

◆ InitialTickRotation

Quaternion KinematicCharacterController.PhysicsMover.InitialTickRotation
getset

Remembers initial rotation before all simulation are done

◆ Transform

Transform KinematicCharacterController.PhysicsMover.Transform
get

The mover's Transform

◆ TransientPosition

Vector3 KinematicCharacterController.PhysicsMover.TransientPosition
get

The mover's rotation (always up-to-date during the character update phase)

◆ TransientRotation

Quaternion KinematicCharacterController.PhysicsMover.TransientRotation
get

The mover's rotation (always up-to-date during the character update phase)


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