Receptive field that generates current based on the amount of contact force, and how close it is to the center of the field. More...

#include <ReceptiveField.h>

Inheritance diagram for AnimatSim::Environment::ReceptiveField:

Collaboration diagram for AnimatSim::Environment::ReceptiveField:

Public Member Functions
	ReceptiveField ()
	Default constructor. More...

	ReceptiveField (float fltX, float fltY, float fltZ, float fltStim)
	Constructor. More...

virtual	~ReceptiveField ()
	Destructor. More...

bool	Equals (float fltX, float fltY, float fltZ)
	Tests if objects are considered equal. More...

bool	GreaterThanThan (float fltX, float fltY, float fltZ)
	Method used to sort the ReceptiveField by vertex. More...

bool	LessThanThan (float fltX, float fltY, float fltZ)
	Method used to sort the ReceptiveField by vertex. More...

virtual void	Load (CStdXml &oXml)

bool	operator< (ReceptiveField *lpItem)
	Method used to sort the ReceptiveField by vertex. More...

bool	operator== (ReceptiveField *lpItem)
	Checks whether the vertices of the receptive fields are the same. More...

bool	operator> (ReceptiveField *lpItem)
	Method used to sort the ReceptiveField by vertex. More...

void	SetVertex (CStdFPoint vPoint)
	Sets the vertex. More...

Public Member Functions inherited from AnimatSim::AnimatBase
	AnimatBase ()
	Constructs an AnimatBase object. More...

virtual	~AnimatBase ()
	Destroys the AnimatBase object.. More...

virtual bool	AddItem (const std::string &strItemType, const std::string &strXml, bool bThrowError=true, bool bDoNotInit=false)
	Adds a new object to this parent. More...

virtual void	AfterResetSimulation ()
	Called after a simulation reset for some objects. More...

virtual long	CalculateSnapshotByteSize ()
	Calculates the snapshot byte size. More...

virtual void	Copy (CStdSerialize *lpSource)

virtual void	Enabled (bool bVal)
	Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...

virtual bool	Enabled ()
	Tells whether this item is enabled or not. This is not actually used for all objects, only specific ones. I am putting it in the base class though to prevent numerous duplications. More...

virtual float *	GetDataPointer (const std::string &strDataType)
	Returns a float pointer to a data item of interest in this object. More...

virtual NeuralModule *	GetNeuralModule ()
	Gets the neural module. More...

virtual Node *	GetNode ()
	Gets the node. More...

virtual Simulator *	GetSimulator ()
	Gets the simulator pointer. More...

virtual Structure *	GetStructure ()
	Gets the structure for this node. More...

virtual bool	HasProperty (const std::string &strName)
	Queries this object if it has a property with the given name. More...

virtual std::string	ID ()
	Gets the unique GUID ID of this object. More...

virtual void	ID (std::string strValue)
	Sets the unique GUID ID of the object. More...

virtual void	Initialize ()
	Initializes this object. More...

virtual void	Kill (bool bState=true)
	Kills. More...

virtual void	Load (StdUtils::CStdXml &oXml)
	Loads the item using an XML data packet. More...

virtual void	LoadKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Loads a key frame snapshot. More...

virtual std::string	Name ()
	Gets the name of this object. More...

virtual void	Name (std::string strValue)
	Sets the name of the object. Blank is acceptable. More...

virtual AnimatPropertyType	PropertyType (const std::string &strName)

virtual void	QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
	Queries this object for a list of properties that can be changed using SetData. More...

virtual void	ReInitialize ()
	Re-initialize this object. More...

virtual bool	RemoveItem (const std::string &strItemType, const std::string &strID, bool bThrowError=true)
	Removes a child item from this parent. More...

virtual void	Reset ()
	Resets this object. More...

virtual void	ResetSimulation ()
	Resets the simulation back to time 0. More...

virtual void	RigidBodyAdded (std::string strID)

virtual void	RigidBodyRemoved (std::string strID)

virtual void	SaveKeyFrameSnapshot (byte *aryBytes, long &lIndex)
	Saves a key frame snapshot. More...

virtual bool	Selected ()
	Tells if this items is selected or not. More...

virtual void	Selected (bool bValue, bool bSelectMultiple)
	Selects this object. More...

virtual bool	SetData (const std::string &strDataType, const std::string &strValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual bool	SetData (const std::string &strDataType, const float fltValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual bool	SetData (const std::string &strDataType, const long lValue, bool bThrowError=true)
	Set a variable based on a string data type name. More...

virtual void	SetSystemPointers (Simulator lpSim, Structure lpStructure, NeuralModule lpModule, Node lpNode, bool bVerify)
	Sets the system pointers. More...

virtual void	SimPausing ()
	Called just before the simulation pauses. More...

virtual void	SimStarting ()
	Called just before the simulation starts. More...

virtual void	SimStopping ()
	Called just before the simulation stops. More...

virtual void	StepSimulation ()
	Step the simulation for this object. More...

virtual void	TimeStepModified ()
	Notification method that the time step modified has been modified. Objects should recalculate any slice times as needed. More...

virtual std::string	Type ()
	returns the string type name of this object. More...

virtual void	Type (std::string strValue)
	Sets the class type for this object. More...

virtual void	VerifySystemPointers ()
	Verify that system pointers have been set correctly. More...

virtual void	VisualSelectionModeChanged (int iNewMode)
	Visual selection mode changed. More...

Static Public Member Functions
static ReceptiveField *	CastToDerived (AnimatBase *lpBase)

Public Attributes
float	m_fltCurrent
	The accumulated current for this receptive field.

StdVector3	m_vVertex
	The vertex of the center of the receptive field in global coordinates.

Additional Inherited Members
Protected Attributes inherited from AnimatSim::AnimatBase
bool	m_bEnabled
	Tells if this item is enabled or not. If it is not enabled then it is not run.

bool	m_bSelected
	Tells whether the object is selected or not.

AnimatSim::Behavior::NeuralModule *	m_lpModule
	The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.

Node *	m_lpNode
	The pointer to this items parent Node. If this is not relevant for this object then this is NULL.

Simulator *	m_lpSim
	The pointer to a Simulation.

AnimatSim::Environment::Structure *	m_lpStructure
	The pointer to this items parent Structure. If this is not relevant for this object then this is NULL.

std::string	m_strID
	The unique Id for this object.

std::string	m_strName
	The name for this object.

std::string	m_strType
	The type for this object. Examples are Box, Plane, Neuron, etc..

Detailed Description

Receptive field that generates current based on the amount of contact force, and how close it is to the center of the field.

Author: dcofer

Date: 3/24/2011

Definition at line 21 of file ReceptiveField.h.

Constructor & Destructor Documentation

AnimatSim::Environment::ReceptiveField::ReceptiveField ( )

Default constructor.

Author: dcofer

Date: 3/24/2011

Definition at line 23 of file ReceptiveField.cpp.

References m_fltCurrent, and m_vVertex.

AnimatSim::Environment::ReceptiveField::ReceptiveField	(	float	fltX,
		float	fltY,
		float	fltZ,
		float	fltCurrent
	)

Constructor.

Author: dcofer

Date: 3/24/2011

Parameters

fltX	The x coordinate of the center of the receptive field.
fltY	The y coordinate of the center of the receptive field.
fltZ	The z coordinate of the center of the receptive field.
fltCurrent	The current value.

Definition at line 40 of file ReceptiveField.cpp.

References m_fltCurrent, and m_vVertex.

AnimatSim::Environment::ReceptiveField::~ReceptiveField ( )

virtual

Destructor.

Author: dcofer

Date: 3/24/2011

Definition at line 52 of file ReceptiveField.cpp.

Member Function Documentation

bool AnimatSim::Environment::ReceptiveField::Equals	(	float	fltX,
		float	fltY,
		float	fltZ
	)

Tests if objects are considered equal.

Author: dcofer

Date: 3/24/2011

Parameters

fltX	The x coordinate to compare with.
fltY	The y coordinate to compare with.
fltZ	The z coordinate to compare with.

Returns: true if this vertices are the same, else false.

Definition at line 207 of file ReceptiveField.cpp.

References m_vVertex.

bool AnimatSim::Environment::ReceptiveField::GreaterThanThan	(	float	fltX,
		float	fltY,
		float	fltZ
	)

Method used to sort the ReceptiveField by vertex.

This method compares the vertex coordinates to find if this vertex is greater than the one passed in.

Author: dcofer

Date: 3/24/2011

Parameters

fltX	The x coordinate to compare with.
fltY	The y coordinate to compare with.
fltZ	The z coordinate to compare with.

Returns: true if this vertex is greater than the one passed in, else false.

Definition at line 192 of file ReceptiveField.cpp.

References LessThanThan().

Here is the call graph for this function:

bool AnimatSim::Environment::ReceptiveField::LessThanThan	(	float	fltX,
		float	fltY,
		float	fltZ
	)

Method used to sort the ReceptiveField by vertex.

This method compares the vertex coordinates to find if this vertex is less than the one passed in.

Author: dcofer

Date: 3/24/2011

Parameters

fltX	The x coordinate to compare with.
fltY	The y coordinate to compare with.
fltZ	The z coordinate to compare with.

Returns: true if this vertex is less than the one passed in, else false.

Definition at line 145 of file ReceptiveField.cpp.

References m_vVertex.

Referenced by GreaterThanThan().

Here is the caller graph for this function:

bool AnimatSim::Environment::ReceptiveField::operator< ( ReceptiveField * lpItem )

Method used to sort the ReceptiveField by vertex.

This method compares the vertex coordinates to find if this vertex is less than the one passed in.

Parameters

[in,out] lpItem Item that is being compared.

Returns: true if this vertex is less than the one passed in, false if not.

Definition at line 80 of file ReceptiveField.cpp.

References m_vVertex.

Referenced by operator>().

Here is the caller graph for this function:

bool AnimatSim::Environment::ReceptiveField::operator== ( ReceptiveField * lpItem )

Checks whether the vertices of the receptive fields are the same.

Same is defined as within 1e-4 difference for each coordinate.

Author: dcofer

Date: 3/24/2011

Parameters

[in,out] lpItem Item that is being compared.

Returns: The result of the operation.

Definition at line 121 of file ReceptiveField.cpp.

References m_vVertex.

bool AnimatSim::Environment::ReceptiveField::operator> ( ReceptiveField * lpItem )

Method used to sort the ReceptiveField by vertex.

This method compares the vertex coordinates to find if this vertex is more than the one passed in.

Parameters

[in,out] lpItem Item that is being compared.

Returns: true if this vertex is more than the one passed in, false if not.

Definition at line 106 of file ReceptiveField.cpp.

References operator<().

Here is the call graph for this function:

void AnimatSim::Environment::ReceptiveField::SetVertex ( CStdFPoint vPoint )

Sets the vertex.

Author: dcofer

Date: 10/5/2011

Parameters

vPoint The point.

Definition at line 64 of file ReceptiveField.cpp.

References m_vVertex.

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

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation