ALBA
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
albaInteractor6DOF Class Reference

#include <albaInteractor6DOF.h>

Inheritance diagram for albaInteractor6DOF:
Inheritance graph
[legend]
Collaboration diagram for albaInteractor6DOF:
Collaboration graph
[legend]

Public Member Functions

 albaAbstractTypeMacro (albaInteractor6DOF, albaInteractorGenericInterface)
 
virtual int StartInteraction (albaDeviceButtonsPadTracker *tracker, albaMatrix *pose=NULL)
 
virtual int StopInteraction (albaDeviceButtonsPadTracker *tracker, albaMatrix *pose=NULL)
 
virtual void SetTrackerPoseMatrix (albaMatrix *pose)
 
albaMatrixGetTrackerPoseMatrix ()
 
void TrackerSnapshot (albaMatrix *pose)
 
void UpdateDeltaTransform ()
 
albaDeviceButtonsPadTrackerGetTracker ()
 
void SetTracker (albaDeviceButtonsPadTracker *tracker)
 
void SetIgnoreTriggerEvents (int flag)
 
int GetIgnoreTriggerEvents ()
 
void IgnoreTriggerEventsOn ()
 
void IgnoreTriggerEventsOff ()
 
void HideAvatar ()
 
void ShowAvatar ()
 
- Public Member Functions inherited from albaInteractorGenericInterface
 ALBA_ID_DEC (MOVE_EVENT)
 
 albaAbstractTypeMacro (albaInteractorGenericInterface, albaInteractor)
 
albaRefSysGetTargetRefSys ()
 
void SetTargetRefSys (albaRefSys &ref_sys)
 
void SetTargetRefSys (albaRefSys *ref_sys)
 
void SetPivotRefSys (albaRefSys &pivot_frame)
 
void SetPivotRefSys (albaRefSys *pivot_frame)
 
albaRefSysGetPivotRefSys ()
 
void EnableTranslation (bool enable)
 
void EnableRotation (bool enable)
 
void EnableScaling (bool enable)
 
void EnableUniformScaling (bool enable)
 
bool GetTranslationFlag ()
 
bool GetRotationFlag ()
 
bool GetScalingFlag ()
 
bool GetUniformScalingFlag ()
 
albaInteractorConstraintGetTranslationConstraint ()
 
void SetTranslationConstraint (albaInteractorConstraint *constrain)
 
albaInteractorConstraintGetRotationConstraint ()
 
void SetRotationConstraint (albaInteractorConstraint *constrain)
 
albaInteractorConstraintGetScaleConstraint ()
 
void SetScaleConstraint (albaInteractorConstraint *constrain)
 
void SetResultMatrix (albaMatrix *result)
 
albaMatrixGetResultMatrix ()
 
void SetResultTransform (albaTransform *result)
 
albaTransformGetResultTransform ()
 
virtual void SetRendererAndView (vtkRenderer *ren, albaView *view)
 
virtual void SetVME (albaVME *vme)
 
void SetSurfaceSnap (bool flag)
 
bool GetSurfaceSnap ()
 
void SurfaceSnapOn ()
 
void SurfaceSnapOff ()
 
void SetSurfaceNormal (bool flag)
 
bool GetSurfaceNormal ()
 
void SurfaceNormalOn ()
 
void SurfaceNormalOff ()
 
- Public Member Functions inherited from albaInteractor
 albaInteractor ()
 
virtual ~albaInteractor ()
 
 ALBA_ID_DEC (INTERACTION_STARTED)
 
 ALBA_ID_DEC (INTERACTION_STOPPED)
 
 ALBA_ID_DEC (BUTTON_DOWN)
 
 ALBA_ID_DEC (BUTTON_UP)
 
 albaAbstractTypeMacro (albaInteractor, albaAgent)
 
virtual void SetRendererAndView (vtkRenderer *ren, albaView *view)
 
vtkRenderer * GetRenderer ()
 
albaViewGetView ()
 
albaDeviceGetDevice ()
 
virtual void SetDevice (albaDevice *)
 
virtual void SetVME (albaVME *vme)
 
void SetProp (vtkProp3D *prop)
 
void SetIgnoreTriggerEvents (bool flag)
 
int GetIgnoreTriggerEvents (bool flag)
 
void IgnoreTriggerEventsOn ()
 
void IgnoreTriggerEventsOff ()
 
void SetStartInteractionEvent (albaID event)
 
albaID GetStartInteractionEvent ()
 
void SetStopInteractionEvent (albaID event)
 
albaID GetStopInteractionEvent ()
 
void SetStartButton (int btn)
 
int GetStartButton ()
 
void SetModifiers (int mod)
 
int GetModifiers ()
 
int GetCurrentButton ()
 
unsigned long GetCurrentModifier ()
 
virtual int StartInteraction (albaDevice *device)
 
virtual int StopInteraction (albaDevice *device)
 
virtual bool IsInteracting ()
 
virtual bool IsInteracting (albaDevice *device)
 
void SetButtonMode (int mode)
 
int GetButtonMode ()
 
void SetButtonModeToSingleButton ()
 
void SetButtonModeToMultiButton ()
 
virtual void OnEvent (albaEventBase *event)
 
void TestModeOn ()
 
void TestModeOff ()
 
bool GetTestMode ()
 
- Public Member Functions inherited from albaAgent
 albaAbstractTypeMacro (albaAgent, albaReferenceCounted)
 
 ALBA_ID_DEC (AGENT_INITIALIZE)
 
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 albaObjectNewObjectInstance () const =0
 
virtual const albaTypeIDGetTypeId () 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)
 
albaObserverCallbackAddObserverCallback (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 albaObserverGetListener ()
 
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)
 

Protected Member Functions

 albaInteractor6DOF ()
 
virtual ~albaInteractor6DOF ()
 
virtual int OnStartInteraction (albaEventInteraction *event)
 
virtual int OnStopInteraction (albaEventInteraction *event)
 
- Protected Member Functions inherited from albaInteractorGenericInterface
 albaInteractorGenericInterface ()
 
virtual ~albaInteractorGenericInterface ()
 
virtual void EnableTranslationInternal (bool enable)
 
virtual void EnableRotationInternal (bool enable)
 
virtual void EnableScalingInternal (bool enable)
 
virtual void EnableUniformScalingInternal (bool enable)
 
- Protected Member Functions inherited from albaInteractor
virtual int OnStartInteraction (albaEventInteraction *e)
 
virtual int OnStopInteraction (albaEventInteraction *e)
 
virtual void OnButtonDown (albaEventInteraction *e)
 
virtual void OnButtonUp (albaEventInteraction *e)
 
void ComputeDisplayToWorld (double x, double y, double z, double worldPt[4])
 
void ComputeWorldToDisplay (double x, double y, double z, double displayPt[3])
 
- 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)
 

Protected Attributes

albaMatrixm_TrackerPoseMatrix
 
albaMatrixm_StartTrackerPoseMatrix
 
albaMatrixm_InverseTrackerPoseMatrix
 
albaMatrixm_InversePoseMatrix
 
albaTransformm_DeltaTransform
 
albaTransformm_TmpTransform
 
albaAvatar3Dm_Avatar
 
- Protected Attributes inherited from albaInteractorGenericInterface
albaInteractorConstraintm_TranslationConstraint
 
albaInteractorConstraintm_RotationConstraint
 
albaInteractorConstraintm_ScaleConstraint
 
albaRefSysm_TargetRefSys
 
albaRefSysm_PivotRefSys
 
albaTransformm_ResultTransform
 
bool m_TranslationFlag
 
bool m_RotationFlag
 
bool m_ScalingFlag
 
bool m_UniformScalingFlag
 
bool m_SurfaceSnap
 
bool m_SurfaceNormal
 
- Protected Attributes inherited from albaInteractor
albaDevicem_Device
 
bool m_DeviceIsSet
 
albaID m_StartInteractionEvent
 
albaID m_StopInteractionEvent
 
int m_IgnoreTriggerEvents
 
int m_InteractionFlag
 
int m_StartButton
 
unsigned long m_Modifiers
 
int m_CurrentButton
 
unsigned long m_CurrentModifier
 
int m_ButtonMode
 
int m_ButtonsCounter
 
albaVMEm_VME
 
albaViewm_View
 
vtkALBASmartPointer< vtkRenderer > m_Renderer
 
vtkALBASmartPointer< vtkProp3D > m_Prop
 
bool m_TestMode
 
- 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
albaObserverm_Listener
 

Additional Inherited Members

- Public Types inherited from albaInteractor
enum  modalities { SINGLE_BUTTON_MODE =0 , MULTI_BUTTON_MODE }
 
- 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 albaTypeIDGetStaticTypeId ()
 
static albaObjectSafeDownCast (albaObject *o)
 
- Protected Types inherited from albaEventBroadcaster
typedef std::list< albaObserver * > albaObserversList
 

Detailed Description

base class for 3D interaction modalities with 6DOF

See also
albaInteractor6DOFMove
Todo:

Definition at line 36 of file albaInteractor6DOF.h.

Constructor & Destructor Documentation

◆ albaInteractor6DOF()

albaInteractor6DOF::albaInteractor6DOF ( )
protected

◆ ~albaInteractor6DOF()

virtual albaInteractor6DOF::~albaInteractor6DOF ( )
protectedvirtual

Member Function Documentation

◆ albaAbstractTypeMacro()

albaInteractor6DOF::albaAbstractTypeMacro ( albaInteractor6DOF  ,
albaInteractorGenericInterface   
)

◆ StartInteraction()

virtual int albaInteractor6DOF::StartInteraction ( albaDeviceButtonsPadTracker tracker,
albaMatrix pose = NULL 
)
virtual

Start the interaction with the selected object.

Reimplemented in albaInteractor6DOFCameraMove.

◆ StopInteraction()

virtual int albaInteractor6DOF::StopInteraction ( albaDeviceButtonsPadTracker tracker,
albaMatrix pose = NULL 
)
virtual

Stop the interaction.

◆ SetTrackerPoseMatrix()

virtual void albaInteractor6DOF::SetTrackerPoseMatrix ( albaMatrix pose)
virtual

Set/Get the current pose matrix.

◆ GetTrackerPoseMatrix()

albaMatrix * albaInteractor6DOF::GetTrackerPoseMatrix ( )
inline

Definition at line 49 of file albaInteractor6DOF.h.

◆ TrackerSnapshot()

void albaInteractor6DOF::TrackerSnapshot ( albaMatrix pose)

Stores the current m_TrackerPoseMatrix.

◆ UpdateDeltaTransform()

void albaInteractor6DOF::UpdateDeltaTransform ( )

Update the delta transform, i.e.

transform from last snapshot

◆ GetTracker()

albaDeviceButtonsPadTracker * albaInteractor6DOF::GetTracker ( )
inline

Return pointer to the current input tracker.

Definition at line 59 of file albaInteractor6DOF.h.

References albaInteractor::m_Device.

◆ SetTracker()

void albaInteractor6DOF::SetTracker ( albaDeviceButtonsPadTracker tracker)

◆ SetIgnoreTriggerEvents()

void albaInteractor6DOF::SetIgnoreTriggerEvents ( int  flag)
inline

Enable/Disable trigger events processing.

Trigger events are StartInteraction and StopInteraction events which are used to start/stop the interaction. If eabled this flag makes the interactor to ingore these events and to be continuously active. Default is false.

Definition at line 67 of file albaInteractor6DOF.h.

◆ GetIgnoreTriggerEvents()

int albaInteractor6DOF::GetIgnoreTriggerEvents ( )
inline

Definition at line 68 of file albaInteractor6DOF.h.

References albaInteractor::m_IgnoreTriggerEvents.

◆ IgnoreTriggerEventsOn()

void albaInteractor6DOF::IgnoreTriggerEventsOn ( )
inline

Definition at line 69 of file albaInteractor6DOF.h.

References albaInteractor::SetIgnoreTriggerEvents().

Here is the call graph for this function:

◆ IgnoreTriggerEventsOff()

void albaInteractor6DOF::IgnoreTriggerEventsOff ( )
inline

Definition at line 70 of file albaInteractor6DOF.h.

References albaInteractor::SetIgnoreTriggerEvents().

Here is the call graph for this function:

◆ HideAvatar()

void albaInteractor6DOF::HideAvatar ( )

Used to hide default tracker's avatar.

◆ ShowAvatar()

void albaInteractor6DOF::ShowAvatar ( )

Used to show back default tracker's avatar.

◆ OnStartInteraction()

virtual int albaInteractor6DOF::OnStartInteraction ( albaEventInteraction event)
protectedvirtual

reimplemented to manage interaction events from trackers

Reimplemented from albaInteractor.

◆ OnStopInteraction()

virtual int albaInteractor6DOF::OnStopInteraction ( albaEventInteraction event)
protectedvirtual

reimplemented to manage interaction events from trackers

Reimplemented from albaInteractor.

Member Data Documentation

◆ m_TrackerPoseMatrix

albaMatrix* albaInteractor6DOF::m_TrackerPoseMatrix
protected

Definition at line 88 of file albaInteractor6DOF.h.

◆ m_StartTrackerPoseMatrix

albaMatrix* albaInteractor6DOF::m_StartTrackerPoseMatrix
protected

Definition at line 89 of file albaInteractor6DOF.h.

◆ m_InverseTrackerPoseMatrix

albaMatrix* albaInteractor6DOF::m_InverseTrackerPoseMatrix
protected

Definition at line 90 of file albaInteractor6DOF.h.

◆ m_InversePoseMatrix

albaMatrix* albaInteractor6DOF::m_InversePoseMatrix
protected

Definition at line 91 of file albaInteractor6DOF.h.

◆ m_DeltaTransform

albaTransform* albaInteractor6DOF::m_DeltaTransform
protected

Definition at line 92 of file albaInteractor6DOF.h.

◆ m_TmpTransform

albaTransform* albaInteractor6DOF::m_TmpTransform
protected

Definition at line 93 of file albaInteractor6DOF.h.

◆ m_Avatar

albaAvatar3D* albaInteractor6DOF::m_Avatar
protected

Definition at line 95 of file albaInteractor6DOF.h.


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