Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

amire::component Namespace Reference


Compounds

class  Action
class  ActionHandler
class  Component
class  ComponentContext
class  ComponentManager
class  ComponentManagerReader
class  ComponentManagerWriter
class  ComponentState
class  ComposedComponent
class  ConfigurationPropertyExport
class  Connection
class  ConnectionFilter
class  DirectionPointerAction
class  DirectionPointerPickingHandler
class  DisplayHandler
class  EmissionListener
class  ExitCommand
class  FalseComponent
class  FrameworkComponent
class  Handler
class  HashCompareComponentState
class  KeyHandler
class  LightComponent
class  MouseHandler
class  MREngine
class  MREngine::SelectionHandler
class  OccluderHandler
class  Position2DAction
class  Position2DPickingHandler
class  Position3DAction
class  Position3DPickingHandler
class  RelayComponent
class  RenderingHandler
class  SlotExport
class  StreamComponentManagerReader
class  StreamComponentManagerWriter
class  TrueComponent
class  Visible2DComponent
class  Visible3DComponent

Typedefs

typedef std::hash_map< long,
int > 
LongToIntMap
typedef std::hash_map< long,
std::string > 
LongToStringMap

Enumerations

enum  RenderMode {
  SETTING_MODE = 0, OPAQUE_RENDER_MODE, SHADOW_RENDER_MODE, BLENDING_RENDER_MODE,
  FOREGROUND_RENDER_MODE
}
enum  PickingMode {
  NORMAL_PICK = 1 << 1, BUTTON1_PRESS_PICK = 1 << 2, BUTTON2_PRESS_PICK = 1 << 3, BUTTON3_PRESS_PICK = 1 << 4,
  BUTTON1_PRESSED_PICK = 1 << 5, BUTTON2_PRESSED_PICK = 1 << 6, BUTTON3_PRESSED_PICK = 1 << 7, BUTTON1_RELEASE_PICK = 1 << 8,
  BUTTON2_RELEASE_PICK = 1 << 9, BUTTON3_RELEASE_PICK = 1 << 10, BUTTON1_CLICK_PICK = 1 << 11, BUTTON2_CLICK_PICK = 1 << 12,
  BUTTON3_CLICK_PICK = 1 << 13, BUTTON1_DOUBLE_CLICK_PICK = 1 << 14, BUTTON2_DOUBLE_CLICK_PICK = 1 << 15, BUTTON3_DOUBLE_CLICK_PICK = 1 << 16,
  WHEEL_UP_PICK = 1 << 17, WHEEL_DOWN_PICK = 1 << 18, SELECT_PICK = 1 << 19
}
enum  PickingMask {
  PICK_NOTHING = 0, PICK_EVERYTHING = -1, PICK_BUTTON1_EVERYTHING = BUTTON1_PRESS_PICK | BUTTON1_PRESSED_PICK | BUTTON1_CLICK_PICK | BUTTON1_DOUBLE_CLICK_PICK, PICK_BUTTON2_EVERYTHING = BUTTON2_PRESS_PICK | BUTTON2_PRESSED_PICK | BUTTON2_CLICK_PICK | BUTTON2_DOUBLE_CLICK_PICK,
  PICK_BUTTON3_EVERYTHING = BUTTON3_PRESS_PICK | BUTTON3_PRESSED_PICK | BUTTON3_CLICK_PICK | BUTTON3_DOUBLE_CLICK_PICK, PICK_BUTTON_PRESS = BUTTON1_PRESS_PICK | BUTTON2_PRESS_PICK | BUTTON3_PRESS_PICK, PICK_BUTTON_PRESSED = BUTTON1_PRESSED_PICK | BUTTON2_PRESSED_PICK | BUTTON3_PRESSED_PICK, PICK_BUTTON_RELEASE = BUTTON1_RELEASE_PICK | BUTTON2_RELEASE_PICK | BUTTON3_RELEASE_PICK,
  PICK_BUTTON_CLICK = BUTTON1_CLICK_PICK | BUTTON2_CLICK_PICK | BUTTON3_CLICK_PICK, PICK_BUTTON_DOUBLE_CLICK = BUTTON1_DOUBLE_CLICK_PICK | BUTTON2_DOUBLE_CLICK_PICK | BUTTON3_DOUBLE_CLICK_PICK, PICK_WHEEL_EVERYTHING = WHEEL_UP_PICK | WHEEL_DOWN_PICK
}

Functions

typedef STD_HASH_MAP (osg::ref_ptr< const ComponentState >, std::vector< int >, HashCompareComponentState) EmissionMap
typedef STD_HASH_MAP (std::string, osg::ref_ptr< Component >, amire::common::HashCompareString) ComponentMap
typedef STD_HASH_MAP (std::string, long, amire::common::HashCompareString) StringToLongMap
typedef STD_HASH_MAP (std::string, osg::ref_ptr< const ComponentState >, amire::common::HashCompareString) ComponentStateMap
typedef STD_HASH_MAP (std::string, osg::ref_ptr< ConnectionFilter >, amire::common::HashCompareString) ConnectionFilterMap
void registerClickable2DImageComponent (amire::component::ComponentManager *componentManager)
void registerClickable3DImageComponent (amire::component::ComponentManager *componentManager)
void registerControlGateComponents (ComponentManager *componentManager)
void registerCoordinateSystemComponent (ComponentManager *componentManager)
void registerGeometryComponent (ComponentManager *componentManager)
void registerHeadLightComponent (ComponentManager *componentManager)
void registerMarkerDetectorComponent (ComponentManager *componentManager)
void registerMarkerGeometryComponent (ComponentManager *componentManager)

Variables

AMIRE_EXPORT_API Connection
AMIRE_EXPORT_API ConnectionFilter
AMIRE_EXPORT_API ComponentManager
AMIRE_EXPORT_API ComponentContext
AMIRE_EXPORT_API MREngine
AMIRE_EXPORT_API Component


Typedef Documentation

typedef std::hash_map<long, int> amire::component::LongToIntMap
 

A LongToIntMap is a hash map mapping a long-key to an int-value.

typedef std::hash_map<long, std::string> amire::component::LongToStringMap
 

A LongToStringMap is a hash map mapping a long-key to a string-value.


Enumeration Type Documentation

enum amire::component::PickingMask
 

A picking handler is registered at the MREngine. Therefore, a mask of all modes that are accepted by the handler must be provided. This mask is a binary OR concationation of the different modes. Several predefined masks are available.

Enumeration values:
PICK_NOTHING 
PICK_EVERYTHING 
PICK_BUTTON1_EVERYTHING 
PICK_BUTTON2_EVERYTHING 
PICK_BUTTON3_EVERYTHING 
PICK_BUTTON_PRESS 
PICK_BUTTON_PRESSED 
PICK_BUTTON_RELEASE 
PICK_BUTTON_CLICK 
PICK_BUTTON_DOUBLE_CLICK 
PICK_WHEEL_EVERYTHING 

enum amire::component::PickingMode
 

The PickingMode represents the different states of a picking device. The number of buttons of a picking device is limited to three buttons. A NORMAL_PICK indicates that the picking device has changes its position and/or its orientation. The modes are combined by a binary OR operation to represent complexer states. When a button gets pressed, moved and released the following modes are used: 1) *_PRESS_PICK indicates the change from not pressed to pressed (the press of the button itself). 2) *_PRESSED_PICK indicates that the position and/or orientation of the picking device has been changed whereas the button is currently pressed. 3) *_RELEASE_PICK indicates the change from pressed to not pressed (the release of the button itself). Further, the click (a press followed by a release in a short period of time) produces a *_CLICK_PICK (the double click is represented by a *_DOUBLE_CLICK_PICK). The different buttons can be destiguished by BUTTON1_*, BUTTON2_*, BUTTON3_*. Additionally, to the interaction events, which are produced by the picking device, there existe the SELECT_PICK. This picking mode is used by the authoring tool to select 2D or 3D components.

Enumeration values:
NORMAL_PICK 
BUTTON1_PRESS_PICK 
BUTTON2_PRESS_PICK 
BUTTON3_PRESS_PICK 
BUTTON1_PRESSED_PICK 
BUTTON2_PRESSED_PICK 
BUTTON3_PRESSED_PICK 
BUTTON1_RELEASE_PICK 
BUTTON2_RELEASE_PICK 
BUTTON3_RELEASE_PICK 
BUTTON1_CLICK_PICK 
BUTTON2_CLICK_PICK 
BUTTON3_CLICK_PICK 
BUTTON1_DOUBLE_CLICK_PICK 
BUTTON2_DOUBLE_CLICK_PICK 
BUTTON3_DOUBLE_CLICK_PICK 
WHEEL_UP_PICK 
WHEEL_DOWN_PICK 
SELECT_PICK 

enum amire::component::RenderMode
 

In the render call-back the render mode is used to show up the the actual OpenGL actions that have to be performerd. The rendering of OpenGL based components is performed in the following order: 1. Rendering of the SETTING_MODE: in this mode all OpenGL setting must be applied. Setting a light source for example would be a task that has to be performed in this mode. 2. Rendering of the OPAQUE_RENDER_MODE: in this mode all opaque virtual objects have to be rendered (every geometry that is not transparent). 3. Rendering of the BLENDING_RENDER_MODE: in this mode all blended (transparent) virtual objects have to be rendered. 4. The depth-buffer is cleared to enable the next mode. 5. Rendering of the FOREGROUND_RENDER_MODE: All virtual objects that should be in the foreground have to be rendered in this mode. A 2D user interface for example would be such a content that should be in the foreground.

Enumeration values:
SETTING_MODE 
OPAQUE_RENDER_MODE 
SHADOW_RENDER_MODE 
BLENDING_RENDER_MODE 
FOREGROUND_RENDER_MODE 


Function Documentation

void registerClickable2DImageComponent amire::component::ComponentManager componentManager  ) 
 

void registerClickable3DImageComponent amire::component::ComponentManager componentManager  ) 
 

void registerControlGateComponents ComponentManager componentManager  ) 
 

void registerCoordinateSystemComponent ComponentManager componentManager  ) 
 

void registerGeometryComponent ComponentManager componentManager  ) 
 

void registerHeadLightComponent ComponentManager componentManager  ) 
 

void registerMarkerDetectorComponent ComponentManager componentManager  ) 
 

void registerMarkerGeometryComponent ComponentManager componentManager  ) 
 

typedef STD_HASH_MAP std::string  ,
osg::ref_ptr< ConnectionFilter ,
amire::common::HashCompareString 
 

A ConnectionFilterMap is a hash map mapping a string-key to a component filter.

typedef STD_HASH_MAP std::string  ,
osg::ref_ptr< const ComponentState ,
amire::common::HashCompareString 
 

A ComponentStateMap is a hash map mapping a string-key to a component state.

typedef STD_HASH_MAP std::string  ,
long  ,
amire::common::HashCompareString 
 

A StringToLongMap is a hash map mapping a string-key to a long-value.

typedef amire::component::STD_HASH_MAP std::string  ,
osg::ref_ptr< Component ,
amire::common::HashCompareString 
 

A ComponentMap is a hash map mapping a string key to a const pointer pointing to a component.

typedef STD_HASH_MAP osg::ref_ptr< const ComponentState ,
std::vector< int >  ,
HashCompareComponentState 
 

The EmissionMap type maps a component state to a vector of integers. This integer vector normally represents the out-slot ids that are emitted when the component state is reached.


Variable Documentation

class AMIRE_EXPORT_API amire::component::Component
 

class AMIRE_EXPORT_API amire::component::ComponentContext
 

class AMIRE_EXPORT_API amire::component::ComponentManager
 

class AMIRE_EXPORT_API amire::component::Connection
 

class AMIRE_EXPORT_API amire::component::ConnectionFilter
 

class AMIRE_EXPORT_API amire::component::MREngine
 


Generated on Tue May 20 17:23:56 2003 for AMIRE-Framework by doxygen1.3