AnimatLab  2
Test
VortexAnimatSim::Visualization::VsSimulationWindow Class Reference
+ Inheritance diagram for VortexAnimatSim::Visualization::VsSimulationWindow:
+ Collaboration diagram for VortexAnimatSim::Visualization::VsSimulationWindow:

Public Member Functions

virtual void Close ()
 Closes this window. More...
 
virtual CStdFPoint GetCameraPosition ()
 
virtual float * GetDataPointer (const std::string &strDataType)
 Returns a float pointer to a data item of interest in this object. More...
 
virtual osg::Matrix GetScreenMatrix ()
 
virtual osg::Viewport * GetViewport ()
 
virtual void Initialize ()
 Initializes this object. More...
 
virtual void OnGetFocus ()
 Called by the GUI when this window gets the focus. More...
 
virtual void OnLoseFocus ()
 Called by the GUI when this window loses the focus. More...
 
virtual void SetCameraLookAt (CStdFPoint oTarget, bool bResetEyePos)
 Manually sets a camera look at position. More...
 
virtual void SetCameraPositionAndLookAt (CStdFPoint oCameraPos, CStdFPoint oTarget)
 Manually sets a camera position and look at position. More...
 
virtual void SetCameraPositionAndLookAt (osg::Vec3d vCameraPos, osg::Vec3d vTarget)
 
virtual void SetCameraPostion (CStdFPoint vCameraPos)
 Manually sets a camera position. More...
 
virtual void SetupTrackCamera (bool bResetEyePos)
 Sets up the camera tracking. More...
 
virtual BodyPart * TrackBody ()
 
virtual void Update ()
 Updates this window. More...
 
virtual void UpdateBackgroundColor ()
 
virtual osgViewer::Viewer * Viewer ()
 
- Public Member Functions inherited from AnimatSim::SimulationWindow
 SimulationWindow (void)
 Default constructor. More...
 
 SimulationWindow (HWND win)
 Constructor. More...
 
 ~SimulationWindow (void)
 Destructor. More...
 
virtual void Load (CStdXml &oXml)
 
virtual void Load (std::string strXml)
 Loads this window from an xml string. More...
 
virtual void LookAtBodyID (std::string strID)
 Sets the RigidBody GUID ID to look at within the specified structure. More...
 
virtual std::string LookAtBodyID ()
 Gets the GUID ID of the RigidBody to look at. More...
 
virtual void LookAtStructureID (std::string strID)
 Sets the GUID ID of the structure to look at with the camera. More...
 
virtual std::string LookAtStructureID ()
 Gets the look at structure GUID ID. More...
 
virtual void QueryProperties (CStdPtrArray< TypeProperty > &aryProperties)
 Queries this object for a list of properties that can be changed using SetData. 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 void SetupTrackCamera (bool bTrackCamera, std::string strLookAtStructureID, std::string strLookAtBodyID)
 Sets up the track camera. More...
 
virtual bool StandAlone ()
 Gets whether this window stands alone from all others. More...
 
virtual void StandAlone (bool bVal)
 Sets whether this window stands alone. More...
 
virtual void UsingTrackCamera (bool bVal)
 Sets whether camera tracking should be used. More...
 
virtual bool UsingTrackCamera ()
 Gets wheter camera tracking is being used. More...
 
virtual HWND WindowID ()
 Gets the HWND window identifier. More...
 
virtual void WindowID (HWND win)
 Sets the HWND Window identifier. 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 NeuralModuleGetNeuralModule ()
 Gets the neural module. More...
 
virtual NodeGetNode ()
 Gets the node. More...
 
virtual SimulatorGetSimulator ()
 Gets the simulator pointer. More...
 
virtual StructureGetStructure ()
 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 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 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...
 

Protected Member Functions

virtual void InitEmbedded (Simulator *lpSim, VsSimulator *lpVsSim)
 
virtual void InitStandalone (Simulator *lpSim, VsSimulator *lpVsSim)
 
virtual void TrackCamera ()
 Implements code to do the camera tracking. More...
 

Protected Attributes

bool m_bEyePosSet
 true if we have set the eye position at least once.
 
float m_fltCameraPosX
 
float m_fltCameraPosY
 
float m_fltCameraPosZ
 
BodyPart * m_lpTrackBody
 
VsSimulationWindowMgrm_lpWinMgr
 
osg::ref_ptr< osgGA::TrackballManipulator > m_osgManip
 
osg::ref_ptr< osgViewer::Viewer > m_osgViewer
 
- Protected Attributes inherited from AnimatSim::SimulationWindow
bool m_bStandAlone
 true if the window is seperate from all other windows.
 
bool m_bTrackCamera
 
HWND m_HWND
 Handle of the hwnd.
 
CStdFPoint m_ptPosition
 The position of the window.
 
CStdFPoint m_ptSize
 Size of the window.
 
std::string m_strLookAtBodyID
 
std::string m_strLookAtStructureID
 
- 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::NeuralModulem_lpModule
 The pointer to this items parentNeuralModule. If this is not relevant for this object then this is NULL.
 
Nodem_lpNode
 The pointer to this items parent Node. If this is not relevant for this object then this is NULL.
 
Simulatorm_lpSim
 The pointer to a Simulation.
 
AnimatSim::Environment::Structurem_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..
 

Additional Inherited Members

- Static Public Member Functions inherited from AnimatSim::SimulationWindow
static SimulationWindowCastToDerived (AnimatBase *lpBase)
 

Detailed Description

Definition at line 8 of file VsSimulationWindow.h.

Member Function Documentation

void VortexAnimatSim::Visualization::VsSimulationWindow::Close ( )
virtual

Closes this window.

Author
dcofer
Date
3/24/2011

Implements AnimatSim::SimulationWindow.

Definition at line 308 of file VsSimulationWindow.cpp.

float * VortexAnimatSim::Visualization::VsSimulationWindow::GetDataPointer ( const std::string &  strDataType)
virtual

Returns a float pointer to a data item of interest in this object.

This is a generic method used to get a pointer to data variable of interest. It is used by a variety of systems in the simulation. The most prominent are the data charting and stimulus classes. Within this method we associate a variable with a string name. By passing in the name of the data type we are interested in we can recieve back a float pointer to that data type. We can use that to read or set the data item in other classes. For example, the data charting system gets the pointer and then each time it needs to log a data point it reads the value into an array.

Author
dcofer
Date
2/22/2011
Parameters
strDataTypename of the data item for which we are looking.
Returns
float pointer of the data item. If not found then it throws an exception.
Exceptions
IfDataType is not found.

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 325 of file VsSimulationWindow.cpp.

References AnimatSim::AnimatBase::m_strName, and StdUtils::Std_CheckString().

+ Here is the call graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::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.

Reimplemented in VortexAnimatSim::Visualization::VsScriptedSimulationWindow.

Definition at line 287 of file VsSimulationWindow.cpp.

References AnimatSim::Simulator::GetWindowMgr(), AnimatSim::SimulationWindow::m_HWND, AnimatSim::AnimatBase::m_lpSim, and SetupTrackCamera().

Referenced by VortexAnimatSim::Visualization::VsScriptedSimulationWindow::Initialize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::OnGetFocus ( )
virtual

Called by the GUI when this window gets the focus.

Author
dcofer
Date
7/19/2011

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 317 of file VsSimulationWindow.cpp.

void VortexAnimatSim::Visualization::VsSimulationWindow::OnLoseFocus ( )
virtual

Called by the GUI when this window loses the focus.

Author
dcofer
Date
7/19/2011

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 321 of file VsSimulationWindow.cpp.

void VortexAnimatSim::Visualization::VsSimulationWindow::SetCameraLookAt ( CStdFPoint  oTarget,
bool  bResetEyePos 
)
virtual

Manually sets a camera look at position.

This can be used to manually set where the camera is looking at.

Author
dcofer
Date
4/19/2011
Parameters
oTargetTarget position to look at.
bResetEyePosIf true it will set the eye position new, if not it will use the current position.

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 102 of file VsSimulationWindow.cpp.

Referenced by SetupTrackCamera().

+ Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::SetCameraPositionAndLookAt ( CStdFPoint  oCameraPos,
CStdFPoint  oTarget 
)
virtual

Manually sets a camera position and look at position.

This can be used to manually set where the camera is looking at.

Author
dcofer
Date
4/19/2011
Parameters
oTargetTarget position to look at.

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 124 of file VsSimulationWindow.cpp.

Referenced by VortexAnimatSim::Visualization::VsScriptedSimulationWindow::DefaultPosition(), SetCameraPostion(), and VortexAnimatSim::Visualization::VsScriptedSimulationWindow::TrackCamera().

+ Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::SetCameraPostion ( CStdFPoint  vCameraPos)
virtual

Manually sets a camera position.

This can be used to manually set where the camera is positioned. This will only set the position if there is a track body defined. It uses the track body to set the look at position.

Author
dcofer
Date
4/19/2011
Parameters
vCameraPosnew Camera position.

Reimplemented from AnimatSim::SimulationWindow.

Definition at line 141 of file VsSimulationWindow.cpp.

References SetCameraPositionAndLookAt().

Referenced by VortexAnimatSim::Visualization::VsScriptedSimulationWindow::SimStarting().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::SetupTrackCamera ( bool  bResetEyePos)
virtual

Sets up the camera tracking.

Author
dcofer
Date
3/24/2011

Implements AnimatSim::SimulationWindow.

Definition at line 71 of file VsSimulationWindow.cpp.

References AnimatSim::Simulator::FindStructureFromAll(), AnimatSim::SimulationWindow::m_bTrackCamera, AnimatSim::AnimatBase::m_lpSim, AnimatSim::SimulationWindow::m_strLookAtBodyID, AnimatSim::SimulationWindow::m_strLookAtStructureID, SetCameraLookAt(), and StdUtils::Std_IsBlank().

Referenced by Initialize().

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::TrackCamera ( )
protectedvirtual

Implements code to do the camera tracking.

Author
dcofer
Date
3/24/2011

Implements AnimatSim::SimulationWindow.

Reimplemented in VortexAnimatSim::Visualization::VsScriptedSimulationWindow.

Definition at line 150 of file VsSimulationWindow.cpp.

Referenced by VortexAnimatSim::Visualization::VsScriptedSimulationWindow::TrackCamera(), and Update().

+ Here is the caller graph for this function:

void VortexAnimatSim::Visualization::VsSimulationWindow::Update ( )
virtual

Updates this window.

Author
dcofer
Date
3/24/2011

Implements AnimatSim::SimulationWindow.

Reimplemented in VortexAnimatSim::Visualization::VsScriptedSimulationWindow.

Definition at line 63 of file VsSimulationWindow.cpp.

References TrackCamera().

+ Here is the call graph for this function:


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