#include <LightManager.h>

Inheritance diagram for AnimatSim::Environment::LightManager:

Collaboration diagram for AnimatSim::Environment::LightManager:

Public Member Functions
	LightManager (void)
	Default constructor. More...

virtual	~LightManager (void)
	Destructor. 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 int	FindChildListPos (std::string strID, bool bThrowError=true)
	Finds the array index for the light with the specified ID. More...

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

virtual CStdPtrArray< Light > *	Lights ()
	Gets the lights array. More...

virtual void	Load (CStdXml &oXml)

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

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

virtual	~AnimatBase ()
	Destroys the AnimatBase object.. 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	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 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 LightManager *	CastToDerived (AnimatBase *lpBase)

Protected Member Functions
virtual void	AddLight (std::string strXml)
	Creates and adds a light. More...

Light *	LoadLight (CStdXml &oXml)
	Loads a Light. More...

virtual void	RemoveLight (std::string strID, bool bThrowError=true)
	Removes the light with the specified ID. More...

virtual void	SetupLights ()

Protected Attributes
CStdPtrArray< Light >	m_aryLights
	Array of Light objects.

int	m_iMaxLights
	The maximum number of lights that can be added to the scene.

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

Light manager class.

This class manages the lights within the scene.

Author: dcofer

Date: 6/29/2011

Definition at line 23 of file LightManager.h.

Constructor & Destructor Documentation

AnimatSim::Environment::LightManager::LightManager ( void )

Default constructor.

Author: dcofer

Date: 3/2/2011

Definition at line 48 of file LightManager.cpp.

AnimatSim::Environment::LightManager::~LightManager ( void )

virtual

Destructor.

Author: dcofer

Date: 3/2/2011

Definition at line 58 of file LightManager.cpp.

Member Function Documentation

bool AnimatSim::Environment::LightManager::AddItem	(	const std::string &	strItemType,
		const std::string &	strXml,
		bool	bThrowError = `true`,
		bool	bDoNotInit = `false`
	)

virtual

Adds a new object to this parent.

Generic method to add a new child item to this parent by specifying a string item type descriptor and an xml packet that can be used to load in the new object. The GUI uses this method to create new items that were added with the user interface. The item type lets the method determine what type of item is being created, like synapse, neuron, body part, etc.. It then gets the modulename, classname, and type from the xml and calls CreateObject to create the appropriate type of object. Then it passes in the xml packet to the new objects load method and does any needed initialization and adds it to the parent.

Author: dcofer

Date: 2/22/2011

Parameters

strItemType	String descriptor of the type of item that is being created.
strXml	XML packet that is used to create and load the new item.
bThrowError	If true then throw an error if there is a problem, otherwise return false.

Returns: true if it succeeds, false if it fails.

Reimplemented from AnimatSim::AnimatBase.

Definition at line 111 of file LightManager.cpp.

References AddLight(), and StdUtils::Std_CheckString().

Referenced by AnimatSim::Simulator::AddItem().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Environment::LightManager::AddLight ( std::string strXml )

protectedvirtual

Creates and adds a light.

Author: dcofer

Date: 3/2/2011

Parameters

strXml The xml data packet for loading the light.

Definition at line 83 of file LightManager.cpp.

References StdUtils::CStdXml::Deserialize(), StdUtils::CStdXml::FindChildElement(), StdUtils::CStdXml::FindElement(), and LoadLight().

Referenced by AddItem().

Here is the call graph for this function:

Here is the caller graph for this function:

int AnimatSim::Environment::LightManager::FindChildListPos	(	std::string	strID,
		bool	bThrowError = `true`
	)

virtual

Finds the array index for the light with the specified ID.

Author: dcofer

Date: 3/2/2011

Parameters

strID	ID of light to find
bThrowError	If true and ID is not found then it will throw an error, else return NULL

Exceptions

If	bThrowError is true and ID is not found.

Returns: If bThrowError is false and ID is not found returns NULL, else returns the pointer to the found part.

Definition at line 158 of file LightManager.cpp.

References AnimatSim::AnimatBase::ID(), m_aryLights, StdUtils::Std_ToUpper(), and StdUtils::Std_Trim().

Referenced by RemoveLight().

Here is the call graph for this function:

Here is the caller graph for this function:

void AnimatSim::Environment::LightManager::Initialize ( )

virtual

Initializes this object.

After an object is loaded in it must be initialized before it can be used. This allows the object to retrieve any pointers or setup memory that it will need during execution. Each object is responsible for initializing any of its child objects, so you simply need to call this method on the containing class to init all child objects. It also calls VerifySystemPointers to make sure that the system pointers have been setup correctly.

Author: dcofer

Date: 3/1/2011

Reimplemented from AnimatSim::AnimatBase.

Definition at line 173 of file LightManager.cpp.

References m_aryLights.

virtual CStdPtrArray<Light>* AnimatSim::Environment::LightManager::Lights ( )

inlinevirtual

Gets the lights array.

Author: dcofer

Date: 3/25/2011

Returns: pointer to the array.

Definition at line 54 of file LightManager.h.

Light * AnimatSim::Environment::LightManager::LoadLight ( CStdXml & oXml )

protected

Loads a Light.

Author: dcofer

Date: 3/25/2011

Parameters

[in,out] oXml The xml for the light to load.

Returns: Pointer to the new simulation window.

Definition at line 211 of file LightManager.cpp.

References AnimatSim::Simulator::CreateObject(), StdUtils::CStdXml::GetChildString(), StdUtils::CStdXml::IntoElem(), AnimatSim::Environment::Light::LightNumber(), m_aryLights, AnimatSim::AnimatBase::m_lpSim, and StdUtils::CStdXml::OutOfElem().

Referenced by AddLight().

Here is the call graph for this function:

Here is the caller graph for this function:

bool AnimatSim::Environment::LightManager::RemoveItem	(	const std::string &	strItemType,
		const std::string &	strID,
		bool	bThrowError = `true`
	)

virtual

Removes a child item from this parent.

This is a generic method that is used to delete a child object from this parent. The GUI uses this method to remove objects from the simulation that have been deleted in the UI. The item type lets the method determine what type of item is being deleted, like synapse, neuron, body part, etc.. The ID is then used to delete that specific item.

Author: dcofer

Date: 2/22/2011

Parameters

strItemType	String descriptor of the type of item that is being created.
strID	Unique ID of the item that will be removed.
bThrowError	If true then throw an error if there is a problem, otherwise return false.