Stg::WorldGui Class Reference

#include <stage.hh>

Inheritance diagram for Stg::WorldGui:

List of all members.

Public Member Functions

virtual std::string ClockString () const
void DrawBoundingBoxTree ()
std::string EnergyString (void) const
CanvasGetCanvas (void) const
virtual bool IsGUI () const
bool IsTopView ()
virtual void Load (const std::string &filename)
usec_t RealTimeNow (void) const
virtual ModelRecentlySelectedModel () const
virtual void Redraw (void)
virtual void RemoveChild (Model *mod)
virtual bool Save (const char *filename)
void Show ()
virtual void Start ()
virtual void Stop ()
virtual void UnLoad ()
virtual bool Update ()
 WorldGui (int W, int H, const char *L=0)
 ~WorldGui ()

Protected Member Functions

void DrawOccupancy () const
void DrawVoxels () const
virtual void PopColor ()
virtual void PushColor (Color col)
virtual void PushColor (double r, double g, double b, double a)

Detailed Description

Extends World to implement an FLTK / OpenGL graphical user interface.


Constructor & Destructor Documentation

WorldGui::WorldGui ( int  W,
int  H,
const char *  L = 0 
)
WorldGui::~WorldGui ( )

Member Function Documentation

std::string WorldGui::ClockString ( void  ) const [virtual]

Get human readable string that describes the current simulation time.

Reimplemented from Stg::World.

void WorldGui::DrawBoundingBoxTree ( )
void WorldGui::DrawOccupancy ( void  ) const [protected]
void WorldGui::DrawVoxels ( ) const [protected]
std::string WorldGui::EnergyString ( void  ) const

Get human readable string that describes the current global energy state.

Canvas* Stg::WorldGui::GetCanvas ( void  ) const [inline]
virtual bool Stg::WorldGui::IsGUI ( ) const [inline, virtual]

Returns true iff this World implements a GUI. The base World class returns false, but subclasses can override this behaviour.

Reimplemented from Stg::World.

bool WorldGui::IsTopView ( )
void WorldGui::Load ( const std::string &  worldfile_path) [virtual]

Open the file at the specified location, create a Worldfile object, read the file and configure the world from the contents, creating models as necessary. The created object persists, and can be retrieved later with World::GetWorldFile().

Reimplemented from Stg::World.

void WorldGui::PopColor ( ) [protected, virtual]

Reimplemented from Stg::World.

void WorldGui::PushColor ( Color  col) [protected, virtual]

Reimplemented from Stg::World.

void WorldGui::PushColor ( double  r,
double  g,
double  b,
double  a 
) [protected, virtual]

Reimplemented from Stg::World.

usec_t WorldGui::RealTimeNow ( void  ) const
Model * WorldGui::RecentlySelectedModel ( ) const [virtual]

Reimplemented from Stg::World.

void WorldGui::Redraw ( void  ) [virtual]

Forces the window to be redrawn, even if paused.

Reimplemented from Stg::World.

void WorldGui::RemoveChild ( Model mod) [virtual]

Reimplemented from Stg::Ancestor.

bool WorldGui::Save ( const char *  filename) [virtual]

Save the current world state into a worldfile with the given filename.

Parameters:
Filenameto save as.

Reimplemented from Stg::World.

void WorldGui::Show ( )

show the window - need to call this if you don't Load().

void WorldGui::Start ( ) [virtual]

Reimplemented from Stg::World.

void WorldGui::Stop ( ) [virtual]

Reimplemented from Stg::World.

void WorldGui::UnLoad ( ) [virtual]

Reimplemented from Stg::World.

bool WorldGui::Update ( void  ) [virtual]

Run one simulation timestep. Advances the simulation clock, executes all simulation updates due at the current time, then queues up future events.

Reimplemented from Stg::World.


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