State

class State

abstract class

Extends: N/A

Implements: N/A

Introduction:

State is the base class by which different broad simulation program conditions are managed. Two different state types currently exist in this simulation framework - Editor State (simulation is stopped, meant for the user to organize objects and set parameters) and Run State (the simulation is actively running). For more information on the relationship between states, objects, and the state machine, please read the detailed description in the State Machine documentation.

Constructor:

Type	Parameter	Description
StateMachine	stateMachine	System state machine

Fields:

Accessibility	Type	Field Name	Description
protected	StateMachine	stateMachine	State machine with reference objects for update loop

Methods

Accessibility	Return Type	Method Name	Description
public	void	enter	actions to be performed when the state machine changes state to this
public	void	exit	actions to be performed when the state machine changes state to another state
public	void	tick	actions to be performed every physics step as determined by the state machine timer