RoboidControl.DigitalSensor Class Reference

Detailed Description

A sensor which can detect touches.

Inheritance diagram for RoboidControl.DigitalSensor:

Public Member Functions
	DigitalSensor (bool invokeEvent=true)
	Create a digital sensor without communication abilities.
	DigitalSensor (Participant owner, byte thingId=0, bool invokeEvent=true)
	Create a digital sensor for a participant.
	DigitalSensor (Thing parent, byte thingId=0, bool invokeEvent=true)
	Create a new child digital sensor.
override void	CreateComponent ()
override byte[]	GenerateBinary ()
	Function used to generate binary data for this digital sensor.
override void	ProcessBinary (byte[] bytes)
	Function used to process binary data received for this digital sensor.
void	AddChild (Thing child)
	Add a child Thing to this Thing.
bool	RemoveChild (Thing child)
	Remove the given thing as a child of this thing.
void	Update (bool recurse=false)
	Update de state of the thing.
virtual void	Update (ulong currentTimeMs, bool recurse=false)
	Update this thing.
delegate void	ChangeHandler ()
delegate void	SphericalHandler (Spherical v)
delegate void	ThingHandler (Thing t)

Static Public Member Functions
static ulong	GetTimeMs ()
	Get the current time in milliseconds.
static void	InvokeNewThing (Thing thing)
	Trigger the creation for the given thing.

Public Attributes
bool	terminate = false
Participant	owner = null
	The participant owning this thing.
byte	id = 0
	The ID of this thing.
byte	type = Type.Undetermined
	The type of this thing.
bool	nameChanged = false
string	modelUrl = ""
	An URL pointing to the location where a model of the thing can be found.
Unity.Thing	component = null
	A reference to the representation of the thing in Unity.
bool	hierarchyChanged = true
	Indicator that the hierarchy of the thing has changed.
bool	positionUpdated = false
	Boolean indicating that the thing has an updated position.
bool	orientationUpdated = false
	Boolean indicating the thing has an updated orientation.
bool	linearVelocityUpdated = false
	Boolean indicating the thing has an updated linear velocity.
bool	angularVelocityUpdated = false
	Boolean indicating the thing has an updated angular velocity.

Protected Attributes
List< Thing >	children = new()
	The children of this thing.

Properties
bool	state [get, set]
virtual string	name [get, set]
	The name of the thing.
Thing	parent [get, set]
	The parent of this thing.
Spherical	position [get, set]
	The position of the thing in local space, in meters.
SwingTwist	orientation [get, set]
	The orientation of the thing in local space.
Spherical	linearVelocity [get, set]
	The linear velocity of the thing in local space in meters per second.
Spherical	angularVelocity [get, set]
	The angular velocity of the thing in local space in degrees per second.

Events
ChangeHandler	OnNameChanged = delegate { }
	Event which is triggered when the name changes.
ChangeHandler	OnPoseChanged = delegate { }
	Event triggered when the pose has changed.
SphericalHandler	OnLinearVelocityChanged = delegate { }
	Event triggered when the linear velocity has changed.
SphericalHandler	OnAngularVelocityChanged = delegate { }
	Event triggered when the angular velocity has changed.
static ThingHandler	OnNewThing = delegate { }
	Event triggered when a new thing has been created.

Constructor & Destructor Documentation

DigitalSensor() [1/3]

RoboidControl.DigitalSensor.DigitalSensor

(

bool

invokeEvent = true

)

Create a digital sensor without communication abilities.

Parameters

invokeEvent

Invoke a OnNewThing event when the thing has been created

DigitalSensor() [2/3]

RoboidControl.DigitalSensor.DigitalSensor	(	Participant	owner,
		byte	thingId = 0,
		bool	invokeEvent = true
	)

Create a digital sensor for a participant.

Parameters

owner	The owning participant
thingId	The ID of the thing, leave out or set to zero to generate an ID
invokeEvent	Invoke a OnNewThing event when the thing has been created

DigitalSensor() [3/3]

RoboidControl.DigitalSensor.DigitalSensor	(	Thing	parent,
		byte	thingId = 0,
		bool	invokeEvent = true
	)

Create a new child digital sensor.

Parameters

parent	The parent thing
thingId	The ID of the thing, leave out or set to zero to generate an ID
invokeEvent	Invoke a OnNewThing event when the thing has been created

Member Function Documentation

CreateComponent()

override void RoboidControl.DigitalSensor.CreateComponent ( )

virtual

Reimplemented from RoboidControl.Thing.

GenerateBinary()

override byte[] RoboidControl.DigitalSensor.GenerateBinary ( )

virtual

Function used to generate binary data for this digital sensor.

Returns

A byte array with the binary data

<remark>The byte array will be empty when the digital status has not changed</remark>

Reimplemented from RoboidControl.Thing.

ProcessBinary()

override void RoboidControl.DigitalSensor.ProcessBinary ( byte[]  bytes )

virtual

Function used to process binary data received for this digital sensor.

Parameters

bytes

The binary data to process

Reimplemented from RoboidControl.Thing.

AddChild()

void RoboidControl.Thing.AddChild ( Thing  child )

inherited

Add a child Thing to this Thing.

Parameters

child

The Thing which should become a child

Remarks

When the Thing is already a child, it will not be added again

RemoveChild()

bool RoboidControl.Thing.RemoveChild ( Thing  child )

inherited

Remove the given thing as a child of this thing.

Parameters

child

The child to remove

Returns

True when the child was present or false when it was not found

GetTimeMs()

static ulong RoboidControl.Thing.GetTimeMs ( )

staticinherited

Get the current time in milliseconds.

Returns

The current time in milliseconds

Update() [1/2]

void RoboidControl.Thing.Update ( bool  recurse = false )

inherited

Update de state of the thing.

Parameters

recurse

When true, this will Update the descendants recursively

Update() [2/2]

virtual void RoboidControl.Thing.Update ( ulong  currentTimeMs, bool  recurse = false  )

virtualinherited

Update this thing.

Parameters

currentTime	he current clock time in milliseconds; if this is zero, the current time is retrieved automatically
recurse	When true, this will Update the descendants recursively

Reimplemented in RoboidControl.DifferentialDrive.

InvokeNewThing()

static void RoboidControl.Thing.InvokeNewThing ( Thing  thing )

staticinherited

Trigger the creation for the given thing.

Parameters

thing

The created thing

Member Data Documentation

type

byte RoboidControl.Thing.type = Type.Undetermined

inherited

The type of this thing.

This can be either a Thing.Type or a byte value for custom types.