Neodroid  0.2.0
Machine Learning Environment Prototyping Tool
droid.Runtime.Environments.AbstractPrototypingEnvironment Class Referenceabstract

More...

Inheritance diagram for droid.Runtime.Environments.AbstractPrototypingEnvironment:
Collaboration diagram for droid.Runtime.Environments.AbstractPrototypingEnvironment:

Public Member Functions

override EnvironmentState ReactAndCollectState (Reaction reaction)
 
void Terminate (string reason="None")
 Termination of an episode, can be supplied with a reason for various purposes debugging or clarification for a learner. More...
 
override void Tick ()
 
override void React (Reaction reaction)
 
override void PostStep ()
 
override void EnvironmentReset ()
 
Vector3 TransformPoint (Vector3 point)
 
void TransformPoint (ref Vector3 point)
 
Vector3 InverseTransformPoint (Vector3 point)
 
void InverseTransformPoint (ref Vector3 point)
 
Vector3 TransformDirection (Vector3 direction)
 
void TransformDirection (ref Vector3 direction)
 
Vector3 InverseTransformDirection (Vector3 direction)
 
void InverseTransformDirection (ref Vector3 direction)
 
Quaternion TransformRotation (Quaternion quaternion)
 
void TransformRotation (ref Quaternion quaternion)
 
Quaternion InverseTransformRotation (Quaternion quaternion)
 
void InverseTransformRotation (ref Quaternion quaternion)
 
void Register (IDisplayer displayer)
 
void Register (IDisplayer obj, string identifier)
 
void Register (IObserver observer)
 
void Register (IObserver observer, string identifier)
 
void Register (IConfigurable configurable)
 
void Register (IConfigurable configurable, string identifier)
 
void Register (IEnvironmentListener environment_listener)
 
void Register (IEnvironmentListener environment_listener, string identifier)
 
void UnRegister (IObserver observer)
 
void UnRegister (IObserver t, string identifier)
 
void UnRegister (IConfigurable configurable)
 
void UnRegister (IConfigurable t, string identifier)
 
void UnRegister (IDisplayer displayer)
 
void UnRegister (IDisplayer t, string identifier)
 
void UnRegister (IEnvironmentListener environment_listener)
 
void UnRegister (IEnvironmentListener t, string identifier)
 
- Public Member Functions inherited from droid.Runtime.Environments.NeodroidEnvironment
abstract Reaction SampleReaction ()
 
abstract EnvironmentState CollectState ()
 
void IdentifierString (DataPoller recipient)
 
void EnergyString (DataPoller recipient)
 
void TerminatedBoolean (DataPoller recipient)
 
abstract void ObservationsString (DataPoller recipient)
 
void FrameString (DataPoller recipient)
 
- Public Member Functions inherited from droid.Runtime.Utilities.GameObjects.PrototypingGameObject
void RefreshStart ()
 
void RefreshAwake ()
 
- Public Member Functions inherited from droid.Runtime.Interfaces.IHasRegister< IObserver >
void Register (T obj)
 
void Register (T obj, string identifier)
 
void UnRegister (T obj)
 
void UnRegister (T t, string obj)
 
- Public Member Functions inherited from droid.Runtime.Interfaces.IHasRegister< IConfigurable >
void Register (T obj)
 
void Register (T obj, string identifier)
 
void UnRegister (T obj)
 
void UnRegister (T t, string obj)
 
- Public Member Functions inherited from droid.Runtime.Interfaces.IHasRegister< IEnvironmentListener >
void Register (T obj)
 
void Register (T obj, string identifier)
 
void UnRegister (T obj)
 
void UnRegister (T t, string obj)
 
- Public Member Functions inherited from droid.Runtime.Interfaces.IHasRegister< IDisplayer >
void Register (T obj)
 
void Register (T obj, string identifier)
 
void UnRegister (T obj)
 
void UnRegister (T t, string obj)
 

Protected Member Functions

void UpdateObserversData ()
 
void UpdateConfigurableValues ()
 
override void PreSetup ()
 
void ResetRegisteredObjects ()
 
void Reconfigure ()
 
abstract void InnerStep (Reaction reaction)
 
abstract void InnerResetRegisteredObjects ()
 
- Protected Member Functions inherited from droid.Runtime.Environments.NeodroidEnvironment
override void Setup ()
 
override void RegisterComponent ()
 
override void UnRegisterComponent ()
 
- Protected Member Functions inherited from droid.Runtime.Utilities.GameObjects.PrototypingGameObject
void Start ()
 
void Awake ()
 
virtual void Clear ()
 

Protected Attributes

Rigidbody [] _Tracked_Rigid_Bodies
 
Transform [] _Poses
 
ObjectiveFunction _objective_function
 
Transform _coordinate_reference_point
 
bool _track_only_children = true
 
CoordinateSystem _coordinate_system = CoordinateSystem.Local_coordinates_
 
BoundingBox _playable_area
 
Object _Reaction_Lock = new Object()
 
int _reset_i
 
WaitForFixedUpdate _Wait_For_Fixed_Update = new WaitForFixedUpdate()
 
List< float > _Observables = new List<float>()
 
List< ActuatorMotion_Sample_Motions = new List<ActuatorMotion>()
 
bool update_observations_with_every_tick = true
 
- Protected Attributes inherited from droid.Runtime.Environments.NeodroidEnvironment
bool _Configure
 
float _Energy_Spent
 
float _Lastest_Reset_Time
 
string _LastTermination_Reason = "None"
 
bool _ReplyWithDescriptionThisStep
 
bool _Resetting
 
IManager _Simulation_Manager
 
bool _Terminable = true
 
bool _Terminated
 
int _current_frame_number
 
- Protected Attributes inherited from droid.Runtime.Utilities.GameObjects.PrototypingGameObject
string _Custom_Name = ""
 

Properties

Dictionary< string, IDisplayerDisplayers [get]
 
Dictionary< string, IConfigurableConfigurables = new Dictionary<string, IDisplayer>() [get]
 
SortedDictionary< string, IObserverObservers = new Dictionary<string, IConfigurable>() [get]
 
Dictionary< string, IEnvironmentListenerListeners = new SortedDictionary<string, IObserver>() [get]
 
override string PrototypingTypeName [get]
 
IObjective ObjectiveFunction [get, set]
 
Transform Transform [get]
 
BoundingBox PlayableArea [get, set]
 
Transform CoordinateReferencePoint [get, set]
 
CoordinateSystem CoordinateSystem [get, set]
 
- Properties inherited from droid.Runtime.Environments.NeodroidEnvironment
abstract override String PrototypingTypeName [get]
 
bool Terminated [get, set]
 
Reaction LastReaction [get, set]
 
bool IsResetting [get]
 
String LastTerminationReason [get, set]
 
int CurrentFrameNumber [get, set]
 
- Properties inherited from droid.Runtime.Utilities.GameObjects.PrototypingGameObject
virtual string PrototypingTypeName [get]
 
string Identifier [get]
 
- Properties inherited from droid.Runtime.Interfaces.IRegisterable
string Identifier [get]
 
- Properties inherited from droid.Runtime.Interfaces.IEnvironment
Reaction LastReaction [get]
 
int CurrentFrameNumber [get]
 
bool Terminated [get]
 
string LastTerminationReason [get]
 
bool IsResetting [get]
 
- Properties inherited from droid.Runtime.Interfaces.IAbstractPrototypingEnvironment
Transform Transform [get]
 
BoundingBox PlayableArea [get]
 
IObjective ObjectiveFunction [get]
 

Events

Action PreStepEvent
 
Action StepEvent
 
Action PostStepEvent
 
- Events inherited from droid.Runtime.Interfaces.IAbstractPrototypingEnvironment
Action PreStepEvent
 
Action StepEvent
 
Action PostStepEvent
 

Detailed Description

Definition at line 20 of file AbstractPrototypingEnvironment.cs.

Member Function Documentation

◆ EnvironmentReset()

override void droid.Runtime.Environments.AbstractPrototypingEnvironment.EnvironmentReset ( )
virtual

◆ InnerResetRegisteredObjects()

abstract void droid.Runtime.Environments.AbstractPrototypingEnvironment.InnerResetRegisteredObjects ( )
protectedpure virtual

◆ InnerStep()

abstract void droid.Runtime.Environments.AbstractPrototypingEnvironment.InnerStep ( Reaction  reaction)
protectedpure virtual

◆ InverseTransformDirection() [1/2]

Vector3 droid.Runtime.Environments.AbstractPrototypingEnvironment.InverseTransformDirection ( Vector3  direction)

Parameters
direction
Returns

Implements droid.Runtime.Interfaces.IAbstractPrototypingEnvironment.

Definition at line 806 of file AbstractPrototypingEnvironment.cs.

◆ InverseTransformDirection() [2/2]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.InverseTransformDirection ( ref Vector3  direction)

Definition at line 823 of file AbstractPrototypingEnvironment.cs.

◆ InverseTransformPoint() [1/2]

Vector3 droid.Runtime.Environments.AbstractPrototypingEnvironment.InverseTransformPoint ( Vector3  point)

Parameters
point
Returns

Implements droid.Runtime.Interfaces.IAbstractPrototypingEnvironment.

Definition at line 719 of file AbstractPrototypingEnvironment.cs.

◆ InverseTransformPoint() [2/2]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.InverseTransformPoint ( ref Vector3  point)

Parameters
point

Definition at line 740 of file AbstractPrototypingEnvironment.cs.

◆ InverseTransformRotation() [1/2]

Quaternion droid.Runtime.Environments.AbstractPrototypingEnvironment.InverseTransformRotation ( Quaternion  quaternion)

◆ InverseTransformRotation() [2/2]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.InverseTransformRotation ( ref Quaternion  quaternion)

Definition at line 895 of file AbstractPrototypingEnvironment.cs.

◆ PostStep()

override void droid.Runtime.Environments.AbstractPrototypingEnvironment.PostStep ( )
virtual

◆ PreSetup()

override void droid.Runtime.Environments.AbstractPrototypingEnvironment.PreSetup ( )
protectedvirtual

◆ React()

override void droid.Runtime.Environments.AbstractPrototypingEnvironment.React ( Reaction  reaction)
virtual

Parameters
reaction
Returns

Implements droid.Runtime.Environments.NeodroidEnvironment.

Definition at line 396 of file AbstractPrototypingEnvironment.cs.

◆ ReactAndCollectState()

override EnvironmentState droid.Runtime.Environments.AbstractPrototypingEnvironment.ReactAndCollectState ( Reaction  reaction)
virtual

◆ Reconfigure()

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Reconfigure ( )
protected

Definition at line 511 of file AbstractPrototypingEnvironment.cs.

◆ Register() [1/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IDisplayer  displayer)

Definition at line 974 of file AbstractPrototypingEnvironment.cs.

◆ Register() [2/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IDisplayer  obj,
string  identifier 
)

Parameters
obj
identifier

Definition at line 981 of file AbstractPrototypingEnvironment.cs.

◆ Register() [3/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IObserver  observer)

Parameters
observer

Definition at line 998 of file AbstractPrototypingEnvironment.cs.

◆ Register() [4/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IObserver  observer,
string  identifier 
)

///

Parameters
observer
identifier

Definition at line 1006 of file AbstractPrototypingEnvironment.cs.

◆ Register() [5/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IConfigurable  configurable)

Parameters
configurable

Definition at line 1024 of file AbstractPrototypingEnvironment.cs.

◆ Register() [6/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IConfigurable  configurable,
string  identifier 
)

Parameters
configurable
identifier

Definition at line 1031 of file AbstractPrototypingEnvironment.cs.

◆ Register() [7/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IEnvironmentListener  environment_listener)

Parameters
environment_listener

Definition at line 1049 of file AbstractPrototypingEnvironment.cs.

◆ Register() [8/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Register ( IEnvironmentListener  environment_listener,
string  identifier 
)

Parameters
environment_listener
identifier

Definition at line 1058 of file AbstractPrototypingEnvironment.cs.

◆ ResetRegisteredObjects()

void droid.Runtime.Environments.AbstractPrototypingEnvironment.ResetRegisteredObjects ( )
protected

Definition at line 487 of file AbstractPrototypingEnvironment.cs.

◆ Terminate()

void droid.Runtime.Environments.AbstractPrototypingEnvironment.Terminate ( string  reason = "None")

Termination of an episode, can be supplied with a reason for various purposes debugging or clarification for a learner.

Parameters
reason

Implements droid.Runtime.Interfaces.IAbstractPrototypingEnvironment.

Definition at line 41 of file AbstractPrototypingEnvironment.cs.

◆ Tick()

override void droid.Runtime.Environments.AbstractPrototypingEnvironment.Tick ( )
virtual

◆ TransformDirection() [1/2]

Vector3 droid.Runtime.Environments.AbstractPrototypingEnvironment.TransformDirection ( Vector3  direction)

Parameters
direction
Returns

Implements droid.Runtime.Interfaces.IAbstractPrototypingEnvironment.

Definition at line 763 of file AbstractPrototypingEnvironment.cs.

◆ TransformDirection() [2/2]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.TransformDirection ( ref Vector3  direction)

Parameters
direction

Definition at line 783 of file AbstractPrototypingEnvironment.cs.

◆ TransformPoint() [1/2]

Vector3 droid.Runtime.Environments.AbstractPrototypingEnvironment.TransformPoint ( Vector3  point)

Parameters
point
Returns

Implements droid.Runtime.Interfaces.IAbstractPrototypingEnvironment.

Definition at line 679 of file AbstractPrototypingEnvironment.cs.

◆ TransformPoint() [2/2]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.TransformPoint ( ref Vector3  point)

Definition at line 696 of file AbstractPrototypingEnvironment.cs.

◆ TransformRotation() [1/2]

Quaternion droid.Runtime.Environments.AbstractPrototypingEnvironment.TransformRotation ( Quaternion  quaternion)

Parameters
quaternion
Returns

Implements droid.Runtime.Interfaces.IAbstractPrototypingEnvironment.

Definition at line 845 of file AbstractPrototypingEnvironment.cs.

◆ TransformRotation() [2/2]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.TransformRotation ( ref Quaternion  quaternion)

Parameters
quaternion

Definition at line 865 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [1/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IObserver  observer)

Parameters
observer

Definition at line 1074 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [2/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IObserver  t,
string  identifier 
)

Parameters
t
identifier

Definition at line 1081 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [3/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IConfigurable  configurable)

Parameters
configurable

Definition at line 1095 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [4/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IConfigurable  t,
string  identifier 
)

Parameters
t
identifier

Definition at line 1104 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [5/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IDisplayer  displayer)

Parameters
displayer

Definition at line 1118 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [6/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IDisplayer  t,
string  identifier 
)

Parameters
t
identifier

Definition at line 1125 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [7/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IEnvironmentListener  environment_listener)

Parameters
environment_listener

Definition at line 1139 of file AbstractPrototypingEnvironment.cs.

◆ UnRegister() [8/8]

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UnRegister ( IEnvironmentListener  t,
string  identifier 
)

Parameters
t
identifier

Definition at line 1148 of file AbstractPrototypingEnvironment.cs.

◆ UpdateConfigurableValues()

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UpdateConfigurableValues ( )
protected

Definition at line 99 of file AbstractPrototypingEnvironment.cs.

◆ UpdateObserversData()

void droid.Runtime.Environments.AbstractPrototypingEnvironment.UpdateObserversData ( )
protected

Definition at line 91 of file AbstractPrototypingEnvironment.cs.

Member Data Documentation

◆ _coordinate_reference_point

Transform droid.Runtime.Environments.AbstractPrototypingEnvironment._coordinate_reference_point
protected

Definition at line 188 of file AbstractPrototypingEnvironment.cs.

◆ _coordinate_system

CoordinateSystem droid.Runtime.Environments.AbstractPrototypingEnvironment._coordinate_system = CoordinateSystem.Local_coordinates_
protected

Definition at line 198 of file AbstractPrototypingEnvironment.cs.

◆ _objective_function

ObjectiveFunction droid.Runtime.Environments.AbstractPrototypingEnvironment._objective_function
protected

Definition at line 182 of file AbstractPrototypingEnvironment.cs.

◆ _Observables

List<float> droid.Runtime.Environments.AbstractPrototypingEnvironment._Observables = new List<float>()
protected

Definition at line 224 of file AbstractPrototypingEnvironment.cs.

◆ _playable_area

BoundingBox droid.Runtime.Environments.AbstractPrototypingEnvironment._playable_area
protected

Definition at line 204 of file AbstractPrototypingEnvironment.cs.

◆ _Poses

Transform [] droid.Runtime.Environments.AbstractPrototypingEnvironment._Poses
protected

Definition at line 134 of file AbstractPrototypingEnvironment.cs.

◆ _Reaction_Lock

Object droid.Runtime.Environments.AbstractPrototypingEnvironment._Reaction_Lock = new Object()
protected

Definition at line 208 of file AbstractPrototypingEnvironment.cs.

◆ _reset_i

int droid.Runtime.Environments.AbstractPrototypingEnvironment._reset_i
protected

Definition at line 214 of file AbstractPrototypingEnvironment.cs.

◆ _Sample_Motions

List<ActuatorMotion> droid.Runtime.Environments.AbstractPrototypingEnvironment._Sample_Motions = new List<ActuatorMotion>()
protected

Definition at line 229 of file AbstractPrototypingEnvironment.cs.

◆ _track_only_children

bool droid.Runtime.Environments.AbstractPrototypingEnvironment._track_only_children = true
protected

Definition at line 193 of file AbstractPrototypingEnvironment.cs.

◆ _Tracked_Rigid_Bodies

Rigidbody [] droid.Runtime.Environments.AbstractPrototypingEnvironment._Tracked_Rigid_Bodies
protected

Definition at line 130 of file AbstractPrototypingEnvironment.cs.

◆ _Wait_For_Fixed_Update

WaitForFixedUpdate droid.Runtime.Environments.AbstractPrototypingEnvironment._Wait_For_Fixed_Update = new WaitForFixedUpdate()
protected

Definition at line 219 of file AbstractPrototypingEnvironment.cs.

◆ update_observations_with_every_tick

bool droid.Runtime.Environments.AbstractPrototypingEnvironment.update_observations_with_every_tick = true
protected

Definition at line 235 of file AbstractPrototypingEnvironment.cs.

Property Documentation

◆ Configurables

Dictionary<string, IConfigurable> droid.Runtime.Environments.AbstractPrototypingEnvironment.Configurables = new Dictionary<string, IDisplayer>()
get

Definition at line 919 of file AbstractPrototypingEnvironment.cs.

◆ CoordinateReferencePoint

Transform droid.Runtime.Environments.AbstractPrototypingEnvironment.CoordinateReferencePoint
getset

Definition at line 955 of file AbstractPrototypingEnvironment.cs.

◆ CoordinateSystem

CoordinateSystem droid.Runtime.Environments.AbstractPrototypingEnvironment.CoordinateSystem
getset

Definition at line 962 of file AbstractPrototypingEnvironment.cs.

◆ Displayers

Dictionary<string, IDisplayer> droid.Runtime.Environments.AbstractPrototypingEnvironment.Displayers
get

Definition at line 915 of file AbstractPrototypingEnvironment.cs.

◆ Listeners

Dictionary<string, IEnvironmentListener> droid.Runtime.Environments.AbstractPrototypingEnvironment.Listeners = new SortedDictionary<string, IObserver>()
get

Definition at line 927 of file AbstractPrototypingEnvironment.cs.

◆ ObjectiveFunction

IObjective droid.Runtime.Environments.AbstractPrototypingEnvironment.ObjectiveFunction
getset

Definition at line 937 of file AbstractPrototypingEnvironment.cs.

◆ Observers

SortedDictionary<string, IObserver> droid.Runtime.Environments.AbstractPrototypingEnvironment.Observers = new Dictionary<string, IConfigurable>()
get

Definition at line 923 of file AbstractPrototypingEnvironment.cs.

◆ PlayableArea

BoundingBox droid.Runtime.Environments.AbstractPrototypingEnvironment.PlayableArea
getset

Definition at line 948 of file AbstractPrototypingEnvironment.cs.

◆ PrototypingTypeName

override string droid.Runtime.Environments.AbstractPrototypingEnvironment.PrototypingTypeName
get
Initial value:
=
new Dictionary<string, IEnvironmentListener>()

Definition at line 933 of file AbstractPrototypingEnvironment.cs.

◆ Transform

Transform droid.Runtime.Environments.AbstractPrototypingEnvironment.Transform
get

Definition at line 944 of file AbstractPrototypingEnvironment.cs.

Event Documentation

◆ PostStepEvent

Action droid.Runtime.Environments.AbstractPrototypingEnvironment.PostStepEvent

Definition at line 172 of file AbstractPrototypingEnvironment.cs.

◆ PreStepEvent

Action droid.Runtime.Environments.AbstractPrototypingEnvironment.PreStepEvent

Definition at line 162 of file AbstractPrototypingEnvironment.cs.

◆ StepEvent

Action droid.Runtime.Environments.AbstractPrototypingEnvironment.StepEvent

Definition at line 167 of file AbstractPrototypingEnvironment.cs.


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