|
ALBA
|
#include <albaAvatar.h>
Public Types | |
| enum | AVATAR_GUI_ID { ID_NAME =MINID , ID_LAST } |
| enum | AvatarModality { MODE_2D =0 , MODE_3D } |
Public Member Functions | |
| albaAbstractTypeMacro (albaAvatar, albaInteractionAgent) | |
| virtual void | SetRendererAndView (vtkRenderer *ren, albaView *view) |
| void | SetActor3D (vtkProp3D *avatar) |
| vtkProp3D * | GetActor3D () |
| void | SetActor2D (vtkActor2D *avatar) |
| vtkActor2D * | GetActor2D () |
| virtual void | Hide () |
| virtual void | Show () |
| virtual void | HideCursor3D () |
| virtual void | ShowCursor3D () |
| virtual void | HideCursor2D () |
| virtual void | ShowCursor2D () |
| virtual int | Pick (albaMatrix &pose) |
| virtual int | Pick (double X, double Y) |
| virtual void | OnEvent (albaEventBase *event) |
| albaDevice * | GetDevice () |
| void | SetDevice (albaDevice *device) |
| albaDeviceButtonsPadTracker * | GetTracker () |
| virtual void | SetTracker (albaDeviceButtonsPadTracker *tracker) |
| void | SetMode (int mode) |
| int | GetMode () |
| void | SetModeTo2D () |
| void | SetModeTo3D () |
| virtual vtkAbstractPropPicker * | GetPicker () |
| albaGUI * | GetGui () |
| virtual void | CreateGui () |
| virtual void | UpdateGui () |
Public Member Functions inherited from albaInteractionAgent | |
| albaInteractionAgent () | |
| virtual | ~albaInteractionAgent () |
| albaAbstractTypeMacro (albaInteractionAgent, albaAgent) | |
| virtual void | SetRendererAndView (vtkRenderer *ren, albaView *view) |
| vtkRenderer * | GetRenderer () |
| albaView * | GetView () |
| virtual void | SetModifierKeys (bool ctrlDown, bool altDown, bool shiftDown) |
| bool | GetCtrlDown () |
| bool | GetAltDown () |
| bool | GetShiftDown () |
Public Member Functions inherited from albaAgent | |
| albaAbstractTypeMacro (albaAgent, albaReferenceCounted) | |
| void | AddObserver (albaObserver *listener, albaID channel=MCH_UP) |
| void | RemoveObserver (albaObserver *listener) |
| void | RemoveAllObservers () |
| virtual void | OnEvent (albaEventBase *event) |
| bool | HasObservers (albaID channel) |
| void | GetObservers (albaID channel, std::vector< albaObserver * > &olist) |
| int | Initialize () |
| void | Shutdown () |
| int | IsInitialized () |
| virtual void | SetName (const char *name) |
| const char * | GetName () |
Public Member Functions inherited from albaReferenceCounted | |
| albaReferenceCounted () | |
| virtual | ~albaReferenceCounted () |
| albaAbstractTypeMacro (albaReferenceCounted, albaObject) | |
| virtual void | Delete () |
| void | Register (void *obj) |
| virtual void | UnRegister (void *obj) |
| int | GetReferenceCount () |
| void | SetReferenceCount (int) |
Public Member Functions inherited from albaObject | |
| albaObject () | |
| virtual | ~albaObject () |
| virtual void | Delete () |
| virtual const char * | GetTypeName () const |
| virtual bool | IsA (const char *type_name) const |
| virtual bool | IsA (const albaTypeID &type_id) const |
| virtual albaObject * | NewObjectInstance () const =0 |
| virtual const albaTypeID & | GetTypeId () const |
| virtual void | Print (std::ostream &os, const int indent=0) const |
| albaObject (const albaObject &c) | |
Public Member Functions inherited from albaObserver | |
| albaObserver () | |
| virtual | ~albaObserver () |
| virtual void | OnEvent (albaEventBase *e)=0 |
Public Member Functions inherited from albaEventBroadcaster | |
| albaEventBroadcaster (void *owner=NULL) | |
| virtual | ~albaEventBroadcaster () |
| albaEventBroadcaster (const albaEventBroadcaster &c) | |
| void | AddObserver (albaObserver *obj) |
| void | AddObserver (albaObserver &obj) |
| albaObserverCallback * | AddObserverCallback (void(*f)(void *sender, albaID eid, void *clientdata, void *calldata)) |
| bool | RemoveObserver (albaObserver *obj) |
| void | RemoveAllObservers () |
| bool | IsObserver (albaObserver *obj) |
| bool | HasObservers () |
| void | GetObservers (std::vector< albaObserver * > &olist) |
| void | InvokeEvent (albaEventBase &e) |
| void | InvokeEvent (albaEventBase *e) |
| void | InvokeEvent (void *sender, albaID id=ID_NO_EVENT, void *data=NULL) |
| void | SetChannel (albaID ch) |
| albaID | GetChannel () |
| virtual void | SetListener (albaObserver *o) |
Public Member Functions inherited from albaEventSender | |
| albaEventSender () | |
| virtual void | SetListener (albaObserver *o) |
| virtual albaObserver * | GetListener () |
| virtual bool | HasListener () |
| virtual void | InvokeEvent (albaEventBase &e) |
| virtual void | InvokeEvent (albaEventBase *e) |
| virtual void | InvokeEvent (void *sender, albaID id=ID_NO_EVENT, void *data=NULL) |
Public Member Functions inherited from albaStorable | |
| albaStorable () | |
| int | Store (albaStorageElement *element) |
| int | Restore (albaStorageElement *element) |
| albaObject * | CastToObject () |
| bool | IsStorable () |
Protected Member Functions | |
| albaAvatar () | |
| virtual | ~albaAvatar () |
| virtual int | InternalStore (albaStorageElement *node) |
| virtual int | InternalRestore (albaStorageElement *node) |
| virtual int | InternalInitialize () |
| virtual void | InternalShutdown () |
Protected Member Functions inherited from albaInteractionAgent | |
| void | ComputeDisplayToWorld (double x, double y, double z, double worldPt[4]) |
| void | ComputeWorldToDisplay (double x, double y, double z, double displayPt[3]) |
| void | SendPickedPointEvent (int eventId, double pos[3], vtkIdType id=0, double scalar=0, albaVME *vme=NULL) |
Protected Member Functions inherited from albaAgent | |
| albaAgent () | |
| virtual | ~albaAgent () |
| virtual int | InternalInitialize () |
| virtual void | InternalShutdown () |
| void | InvokeEvent (albaEventBase &event, albaID channel=-1) |
| void | InvokeEvent (albaEventBase *event, albaID channel=-1) |
| void | InvokeEvent (void *sender, int id, albaID channel=MCH_UP, void *data=NULL) |
| virtual int | InternalStore (albaStorageElement *node)=0 |
| virtual int | InternalRestore (albaStorageElement *node)=0 |
Protected Attributes | |
| vtkALBASmartPointer< vtkProp3D > | m_Actor3D |
| vtkALBASmartPointer< vtkActor2D > | m_Actor2D |
| albaDevice * | m_Device |
| albaGUI * | m_Gui |
| int | m_Mode |
| int | m_Cursor3DHideCounter |
| int | m_Cursor2DHideCounter |
Protected Attributes inherited from albaInteractionAgent | |
| albaView * | m_View |
| vtkALBASmartPointer< vtkRenderer > | m_Renderer |
| bool | m_CtrlDown |
| bool | m_AltDown |
| bool | m_ShiftDown |
Protected Attributes inherited from albaAgent | |
| albaString | m_Name |
| bool | m_Initialized |
| std::vector< albaEventBroadcaster * > | m_Channels |
Protected Attributes inherited from albaReferenceCounted | |
| int | m_ReferenceCount |
Protected Attributes inherited from albaObject | |
| bool | m_HeapFlag |
Protected Attributes inherited from albaEventBroadcaster | |
| albaObserversList | m_Observers |
| albaID | m_Channel |
Protected Attributes inherited from albaEventSender | |
| albaObserver * | m_Listener |
Protected Attributes inherited from albaStorable | |
| bool | m_Storable |
Additional Inherited Members | |
Static Public Member Functions inherited from albaObject | |
| static const char * | GetStaticTypeName () |
| static bool | IsStaticType (const char *type_name) |
| static bool | IsStaticType (const albaTypeID &type_id) |
| static const albaTypeID & | GetStaticTypeId () |
| static albaObject * | SafeDownCast (albaObject *o) |
Static Public Member Functions inherited from albaStorable | |
| static albaStorable * | SafeCastToObject (albaObject *o) |
Protected Types inherited from albaEventBroadcaster | |
| typedef std::list< albaObserver * > | albaObserversList |
Avatars are entities moving in the virtual world according to user's movements, and thus representing their presence in the virtual world.
Specialized classes must set the Avatar variable with a vtkProp3D, this class will take care of adding it to the current renderer, moving, hiding and showing it at the right time. The Avatar moves according to the device it observes, which must also be set by subclasses.
Definition at line 48 of file albaAvatar.h.
| Enumerator | |
|---|---|
| ID_NAME | |
| ID_LAST | |
Definition at line 54 of file albaAvatar.h.
| Enumerator | |
|---|---|
| MODE_2D | |
| MODE_3D | |
Definition at line 60 of file albaAvatar.h.
|
protected |
|
protectedvirtual |
| albaAvatar::albaAbstractTypeMacro | ( | albaAvatar | , |
| albaInteractionAgent | |||
| ) |
|
virtual |
Set the renderer this avatar is attached to.
When the rederer is changed, all props created by this avatar are moved to the new renderer and the interaction is changed accordingly
Reimplemented from albaInteractionAgent.
Reimplemented in albaAvatar3D.
| void albaAvatar::SetActor3D | ( | vtkProp3D * | avatar | ) |
Set the actor used to display the 3D cursor.
|
inline |
Return the prop3D used for this avatar.
Definition at line 80 of file albaAvatar.h.
| void albaAvatar::SetActor2D | ( | vtkActor2D * | avatar | ) |
Set the actor used to display the 2D cursor.
|
inline |
Return the prop3D used for this avatar.
Definition at line 87 of file albaAvatar.h.
|
virtual |
Hide all the Avatar's graphics actors, i.e.
remove actor from renderer's list. This is usually used to compute bounding box without considering avatars
Reimplemented in albaAvatar3D.
|
virtual |
Show all the Avatar's graphics actors.
This function is conditional, in the sense the old visibility state is retained when showing back.
Reimplemented in albaAvatar3D.
|
virtual |
Hide the Avatar's 3D cursor actor, i.e.
remove its actor from renderer's list.
|
virtual |
Show the Avatar's 3D cursor actor.
This function is conditional, in the sense the old visibility state is retained when showing back.
|
virtual |
Hide the Avatar's 2D cursor actor, i.e.
remove its actor from renderer's list.
|
virtual |
Show the Avatar's 2D cursor actor.
This function is conditional, in the sense the old visibility state is retained when showing back.
|
inlinevirtual |
pick in the scene with this avatar, give the avatar pose
Reimplemented in albaAvatar3DCone.
Definition at line 118 of file albaAvatar.h.
|
inlinevirtual |
Definition at line 119 of file albaAvatar.h.
|
virtual |
Process events coming from tracker: the base avatar does not forward them (see albaAgent::OnEvent)
Reimplemented from albaAgent.
Reimplemented in albaAvatar3D.
|
inline |
Return the device the avatar follows.
Definition at line 125 of file albaAvatar.h.
| void albaAvatar::SetDevice | ( | albaDevice * | device | ) |
Set the device the avatar follows: the avatar observes its input channel.
| albaDeviceButtonsPadTracker * albaAvatar::GetTracker | ( | ) |
Return settings object for this Avatar, and if not yet allocated create it.
Settings objects usually include a GUI for interactive settings. return the tracker attached to this avatar: the avatar usually follows the movements of the tracker
|
virtual |
set the tracker attached to this avatar: the avatar usually follows the movements of the tracker
Reimplemented in albaAvatar3D.
|
inline |
Set Avatar modality: MODE_2D or MODE_3D.
Definition at line 145 of file albaAvatar.h.
|
inline |
return the current avatar modality.
This is used by avatars with a double bhavior.
Definition at line 148 of file albaAvatar.h.
|
inline |
Set Avatar modality to MODE_2D.
Definition at line 151 of file albaAvatar.h.
|
inline |
Set Avatar modality to MODE_3D.
Definition at line 154 of file albaAvatar.h.
|
inlinevirtual |
return the picker used by this avatar: from the picker is possible to obtain information about the picked object.
Reimplemented in albaAvatar3D.
Definition at line 159 of file albaAvatar.h.
| albaGUI * albaAvatar::GetGui | ( | ) |
Return pointer to the GUI.
|
virtual |
internal function to create device GUI for settings
Reimplemented in albaAvatar3D.
|
virtual |
force GUI update
|
protectedvirtual |
This is used to allow nested serialization of subclasses.
This function is called by Store and is reimplemented in subclasses. Each subclass can Open/Close its own subelements which are closed inside the "Device" XML element.
Implements albaStorable.
Reimplemented in albaAvatar3D.
|
protectedvirtual |
This is called by Restore() and must be reimplemented by subclasses The element from which the object should restore itself is passed as argument.
Implements albaStorable.
Reimplemented in albaAvatar3D.
|
protectedvirtual |
redefined to add the Cursor actor into the selected renderer
Reimplemented from albaAgent.
Reimplemented in albaAvatar3D.
|
protectedvirtual |
redefined to remove Cursor from renderer
Reimplemented from albaAgent.
Reimplemented in albaAvatar3D.
|
protected |
3D representation of the avatar
Definition at line 190 of file albaAvatar.h.
|
protected |
2D representation of the avatar
Definition at line 191 of file albaAvatar.h.
|
protected |
the device the avatar follows
Definition at line 193 of file albaAvatar.h.
|
protected |
the settings Gui
Definition at line 194 of file albaAvatar.h.
|
protected |
Avatar modality, either 2D or 3D
Definition at line 195 of file albaAvatar.h.
|
protected |
counter of the HideCursor3D() calls, used to manage concurrent calls
Definition at line 197 of file albaAvatar.h.
|
protected |
counter of the HideCursor2D() calls, used to manage concurrent calls
Definition at line 198 of file albaAvatar.h.