Contents User Forum Source Index APIs by Task APIs by Level Data


G3D::Manipulator Class Reference

Exports a coordinate frame, typically in response to user input. More...

#include <Widget.h>

Inherits G3D::Widget.

Inherited by G3D::FirstPersonManipulator, G3D::ThirdPersonManipulator, and G3D::UprightSplineManipulator.

List of all members.

Public Types

typedef ReferenceCountedPointer<
class Manipulator
Ref

Public Member Functions

virtual void fireEvent (const GEvent &event)
virtual CoordinateFrame frame () const=0
virtual void getFrame (CoordinateFrame &c) const =0
virtual bool onEvent (const GEvent &event)=0
virtual void onLogic ()=0
virtual void onNetwork ()=0
virtual void onPose (Array< PosedModel::Ref > &posedArray, Array< PosedModel2DRef > &posed2DArray)=0
virtual void onSimulation (RealTime rdt, SimTime sdt, SimTime idt)=0
virtual void onUserInput (UserInput *ui)=0
void ReferenceCountedObject_zeroWeakPointers ()
virtual void setManager (WidgetManager *m)
virtual GWindowwindow () const

Public Attributes

AtomicInt32 ReferenceCountedObject_refCount
_WeakPtrLinkedListReferenceCountedObject_weakPointer

Protected Attributes

WidgetManagerm_manager


Detailed Description

Exports a coordinate frame, typically in response to user input.

Examples: G3D::ThirdPersonManipulator, G3D::FirstPersonManipulator


Member Typedef Documentation


Member Function Documentation

virtual void G3D::Widget::fireEvent ( const GEvent event  )  [virtual, inherited]

Fire an event on the containing window.

Reimplemented in G3D::WidgetManager.

virtual CoordinateFrame G3D::Manipulator::frame (  )  const [pure virtual]

virtual void G3D::Manipulator::getFrame ( CoordinateFrame c  )  const [pure virtual]

virtual bool G3D::Widget::onEvent ( const GEvent event  )  [pure virtual, inherited]

Returning true consumes the event and prevents other GModules from seeing it.

Motion events (GEventType::MOUSEMOTION, GEventType::JOYHATMOTION, JGEventType::OYBALLMOTION, and GEventType::JOYAXISMOTION) cannot be cancelled.

Implemented in G3D::CameraControlWindow, G3D::DeveloperWindow, G3D::FirstPersonManipulator, G3D::GConsole, G3D::GuiWindow, G3D::ThirdPersonManipulator, G3D::UprightSplineManipulator, and G3D::WidgetManager.

virtual void G3D::Widget::onLogic (  )  [pure virtual, inherited]

virtual void G3D::Widget::onNetwork (  )  [pure virtual, inherited]

virtual void G3D::Widget::onPose ( Array< PosedModel::Ref > &  posedArray,
Array< PosedModel2DRef > &  posed2DArray 
) [pure virtual, inherited]

Appends a posed model for this object to the array, if it has a graphic representation.

The posed model appended is allowed to reference the agent and is allowed to mutate if the agent is mutated.

Implemented in G3D::FirstPersonManipulator, G3D::GConsole, G3D::ThirdPersonManipulator, and G3D::WidgetManager.

virtual void G3D::Widget::onSimulation ( RealTime  rdt,
SimTime  sdt,
SimTime  idt 
) [pure virtual, inherited]

virtual void G3D::Widget::onUserInput ( UserInput ui  )  [pure virtual, inherited]

void G3D::ReferenceCountedObject::ReferenceCountedObject_zeroWeakPointers (  )  [inline, inherited]

Automatically called immediately before the object is deleted.

This is not called from the destructor because it needs to be invoked before the subclass destructor.

virtual void G3D::Widget::setManager ( WidgetManager m  )  [inline, virtual, inherited]

Called by the WidgetManager when this module is added to it.

The argument may be NULL

Reimplemented in G3D::DeveloperWindow.

virtual GWindow* G3D::Widget::window (  )  const [virtual, inherited]

Returns the operating system window that is currently rendering this Widget.

Reimplemented in G3D::WidgetManager.


Member Data Documentation

WidgetManager* G3D::Widget::m_manager [protected, inherited]

The manager, set by setManager().

This cannot be a reference counted pointer because that would create a cycle between the Widget and its manager.

The long name is to keep this from accidentally conflicting with a subclass's variable name.

Do not use or explicitly manipulate this value--its type may change in the future and is not part of the supported API.

Linked list of all weak pointers that reference this (some may be on the stack!).

Do not use or explicitly manipulate this value.


The documentation for this class was generated from the following file:
Generated on Thu Aug 2 11:40:46 2007 for G3D by doxygen 1.5.2
Hosted by SourceForge.net Logo