ALBA
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
albaGizmoCrossTranslatePlane Class Reference

#include <albaGizmoCrossTranslatePlane.h>

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

Public Types

enum  PLANE { X_NORMAL = 0 , Y_NORMAL , Z_NORMAL }
 
enum  GIZMOPARTS { S0 = 0 , S1 , NUM_GIZMO_PARTS }
 
enum  GIZMO_STATUS { SELECTED = 0 , NOT_SELECTED }
 
- Public Types inherited from albaGizmoInterface
enum  MODALITY { G_LOCAL = 0 , G_GLOBAL }
 

Public Member Functions

 albaGizmoCrossTranslatePlane (albaVME *input, albaObserver *listener=NULL)
 
virtual ~albaGizmoCrossTranslatePlane ()
 
void SetInput (albaVME *vme)
 
albaVME * GetInput ()
 
void SetListener (albaObserver *Listener)
 
virtual void OnEvent (albaEventBase *alba_event)
 
void SetPlane (int axis)
 
int GetPlane ()
 
void Highlight (bool highlight)
 
void Show (bool show)
 
void ShowTranslationFeedbackArrows (bool show)
 
void SetIsActive (bool highlight)
 
bool GetIsActive ()
 
void SetAbsPose (albaMatrix *absPose)
 
albaMatrix * GetAbsPose ()
 
void SetConstrainRefSys (albaMatrix *constrain)
 
void SetConstraintModality (int axis, int constrainModality)
 
void SetStep (int axis, double step)
 
void SetColor (int part, double col[3])
 
void SetColor (int part, double colR, double colG, double colB)
 
- Public Member Functions inherited from albaGizmoInterface
void SetName (albaString name)
 
albaString GetName ()
 
virtual void SetInput (albaVME *vme)
 
albaVME * GetInput ()
 
void SetMediator (albaObserver *mediator)
 
albaObserver * GetMediator ()
 
void SetAutoscale (bool autoscale)
 
bool GetAutoscale ()
 
void SetRenderWindowHeightPercentage (double percentage)
 
double GetRenderWindowHeightPercentage ()
 
void SetAlwaysVisible (bool alwaysVisible)
 
bool GetAlwaysVisible ()
 
void SetListener (albaObserver *listener)
 
albaObserver * GetListener ()
 
virtual void OnEvent (albaEventBase *alba_event)
 
virtual void Show (bool show)
 
void SetModalityToLocal ()
 
void SetModalityToGlobal ()
 
int GetModality ()
 
virtual void SetAbsPose (albaMatrix *absPose)
 
virtual albaMatrix * GetAbsPose ()
 
virtual albaGUI * GetGui ()
 
- Public Member Functions inherited from albaObserver
 albaObserver ()
 
virtual ~albaObserver ()
 
virtual void OnEvent (albaEventBase *e)=0
 

Protected Member Functions

void SetSizeLength (double length)
 
double GetSizeLength ()
 
void CreatePipeline ()
 
void CreateFeedbackGizmoPipeline ()
 
void CreateISA ()
 
- Protected Member Functions inherited from albaGizmoInterface
 albaGizmoInterface ()
 
virtual ~albaGizmoInterface ()
 
void SendTransformMatrix (albaMatrix *matrix, int eventId, long arg)
 
virtual void OnEventGizmoGui (albaEventBase *alba_event)
 
virtual void OnEventGizmoComponents (albaEventBase *alba_event)
 

Protected Attributes

double m_Color [3][2]
 
double m_LastColor [3][2]
 
albaVMEGizmo * m_Gizmo [3]
 
albaVME * m_InputVme
 
int m_ActivePlane
 
double m_Length
 
vtkLineSource * m_Line [2]
 
vtkTubeFilter * m_LineTF [2]
 
vtkTransformPolyDataFilter * m_RotatePDF [3]
 
vtkTransform * m_RotationTr
 
albaInteractorCompositorMouse * m_IsaComp [2]
 
albaInteractorGenericMouse * m_IsaGen [2]
 
vtkTransform * m_PivotTransform
 
albaObserver * m_Listener
 
bool m_IsActive
 
albaVMEGizmo * m_TranslationFeedbackGizmo
 
vtkConeSource * m_FeedbackConeSource
 
vtkTransform * m_LeftFeedbackConeTransform
 
vtkTransform * m_RightFeedbackConeTransform
 
vtkTransform * m_UpFeedbackConeTransform
 
vtkTransform * m_DownFeedbackConeTransform
 
vtkTransformPolyDataFilter * m_LeftFeedbackConeTransformPDF
 
vtkTransformPolyDataFilter * m_RightFeedbackConeTransformPDF
 
vtkTransformPolyDataFilter * m_UpFeedbackConeTransformPDF
 
vtkTransformPolyDataFilter * m_DownFeedbackConeTransformPDF
 
vtkCylinderSource * m_FeedbackCylinderSource
 
vtkTransform * m_HorizontalFeedbackCylinderTransform
 
vtkTransform * m_VerticalFeedbackCylinderTransform
 
vtkTransformPolyDataFilter * m_VerticalFeedbackCylinderTransformPDF
 
vtkTransformPolyDataFilter * m_HorizontalFeedbackCylinderTransformPDF
 
vtkAppendPolyData * m_FeedbackStuffAppendPolydata
 
- Protected Attributes inherited from albaGizmoInterface
albaObserver * m_Mediator
 
albaString m_Name
 
albaVME * m_InputVME
 
int m_Modality
 
albaObserver * m_Listener
 
albaVME * m_RefSysVME
 
bool m_Visibility
 
double m_RenderWindowHeightPercentage
 
bool m_AlwaysVisible
 
bool m_Autoscale
 

Friends

class albaGizmoTranslatePlaneTest
 

Detailed Description

Basic gizmo component used to perform constrained translation on a plane.

See also
albaGizmoTranslate

Definition at line 61 of file albaGizmoCrossTranslatePlane.h.

Member Enumeration Documentation

◆ PLANE

enum albaGizmoCrossTranslatePlane::PLANE

Plane enum.

Enumerator
X_NORMAL 
Y_NORMAL 
Z_NORMAL 

Definition at line 87 of file albaGizmoCrossTranslatePlane.h.

◆ GIZMOPARTS

enum albaGizmoCrossTranslatePlane::GIZMOPARTS

z z y ^ ^ ^

----—> y ----—>x ----—> x

YZ XZ XY

z ^ S2 |--— | |
| SQ |S1
| |
-----—> y

Enumerator
S0 
S1 
NUM_GIZMO_PARTS 

Definition at line 158 of file albaGizmoCrossTranslatePlane.h.

◆ GIZMO_STATUS

enum albaGizmoCrossTranslatePlane::GIZMO_STATUS
Enumerator
SELECTED 
NOT_SELECTED 

Definition at line 159 of file albaGizmoCrossTranslatePlane.h.

Constructor & Destructor Documentation

◆ albaGizmoCrossTranslatePlane()

albaGizmoCrossTranslatePlane::albaGizmoCrossTranslatePlane ( albaVME *  input,
albaObserver *  listener = NULL 
)

◆ ~albaGizmoCrossTranslatePlane()

virtual albaGizmoCrossTranslatePlane::~albaGizmoCrossTranslatePlane ( )
virtual

Member Function Documentation

◆ SetInput()

void albaGizmoCrossTranslatePlane::SetInput ( albaVME *  vme)
virtual

Set the gizmo generating vme; the gizmo will be centered on this vme.

Reimplemented from albaGizmoInterface.

◆ GetInput()

albaVME * albaGizmoCrossTranslatePlane::GetInput ( )
inline

Definition at line 70 of file albaGizmoCrossTranslatePlane.h.

References m_InputVme.

◆ SetListener()

void albaGizmoCrossTranslatePlane::SetListener ( albaObserver *  Listener)
inline

Set the event receiver object.

Definition at line 77 of file albaGizmoCrossTranslatePlane.h.

References m_Listener.

◆ OnEvent()

virtual void albaGizmoCrossTranslatePlane::OnEvent ( albaEventBase *  alba_event)
virtual

Events handling.

Reimplemented from albaGizmoInterface.

◆ SetPlane()

void albaGizmoCrossTranslatePlane::SetPlane ( int  axis)

Set/Get gizmo plane, default plane is X_NORMAL.

◆ GetPlane()

int albaGizmoCrossTranslatePlane::GetPlane ( )
inline

Get gizmo Plane.

Definition at line 93 of file albaGizmoCrossTranslatePlane.h.

References m_ActivePlane.

◆ Highlight()

void albaGizmoCrossTranslatePlane::Highlight ( bool  highlight)

Highlight gizmo.

◆ Show()

void albaGizmoCrossTranslatePlane::Show ( bool  show)
virtual

Show plane translation gizmo.

Reimplemented from albaGizmoInterface.

◆ ShowTranslationFeedbackArrows()

void albaGizmoCrossTranslatePlane::ShowTranslationFeedbackArrows ( bool  show)

Show the translation feedback arrows

◆ SetIsActive()

void albaGizmoCrossTranslatePlane::SetIsActive ( bool  highlight)
inline

Set/Get the activation status of the gizmo, When the gizmo is active it is sending pose matrices to the listener.

Definition at line 114 of file albaGizmoCrossTranslatePlane.h.

References m_IsActive.

◆ GetIsActive()

bool albaGizmoCrossTranslatePlane::GetIsActive ( )
inline

Definition at line 115 of file albaGizmoCrossTranslatePlane.h.

References m_IsActive.

◆ SetAbsPose()

void albaGizmoCrossTranslatePlane::SetAbsPose ( albaMatrix *  absPose)
virtual

Set the abs pose.

Reimplemented from albaGizmoInterface.

◆ GetAbsPose()

albaMatrix * albaGizmoCrossTranslatePlane::GetAbsPose ( )
virtual

Get the gizmo abs pose.

Reimplemented from albaGizmoInterface.

◆ SetConstrainRefSys()

void albaGizmoCrossTranslatePlane::SetConstrainRefSys ( albaMatrix *  constrain)

Set the constrain ref sys.

◆ SetConstraintModality()

void albaGizmoCrossTranslatePlane::SetConstraintModality ( int  axis,
int  constrainModality 
)

Set the constraint modality for the given axis; allowed constraint modality are: LOCK, FREE, BOUNDS, SNAP_STEP, SNAP_ARRAY.

◆ SetStep()

void albaGizmoCrossTranslatePlane::SetStep ( int  axis,
double  step 
)

Set the step value for snap step constraint type for the given axis.

◆ SetColor() [1/2]

void albaGizmoCrossTranslatePlane::SetColor ( int  part,
double  col[3] 
)

Gizmo color setting facilities for gizmo segments;.

◆ SetColor() [2/2]

void albaGizmoCrossTranslatePlane::SetColor ( int  part,
double  colR,
double  colG,
double  colB 
)

◆ SetSizeLength()

void albaGizmoCrossTranslatePlane::SetSizeLength ( double  length)
protected

Set/Get the side length of the gizmo.

◆ GetSizeLength()

double albaGizmoCrossTranslatePlane::GetSizeLength ( )
inlineprotected

Definition at line 165 of file albaGizmoCrossTranslatePlane.h.

References m_Length.

◆ CreatePipeline()

void albaGizmoCrossTranslatePlane::CreatePipeline ( )
protected

Create vtk objects needed.

◆ CreateFeedbackGizmoPipeline()

void albaGizmoCrossTranslatePlane::CreateFeedbackGizmoPipeline ( )
protected

Create feedback gizmo vtk objects.

◆ CreateISA()

void albaGizmoCrossTranslatePlane::CreateISA ( )
protected

Create isa stuff.

Friends And Related Function Documentation

◆ albaGizmoTranslatePlaneTest

friend class albaGizmoTranslatePlaneTest
friend

Definition at line 245 of file albaGizmoCrossTranslatePlane.h.

Member Data Documentation

◆ m_Color

double albaGizmoCrossTranslatePlane::m_Color[3][2]
protected

Definition at line 167 of file albaGizmoCrossTranslatePlane.h.

◆ m_LastColor

double albaGizmoCrossTranslatePlane::m_LastColor[3][2]
protected

Definition at line 168 of file albaGizmoCrossTranslatePlane.h.

◆ m_Gizmo

albaVMEGizmo* albaGizmoCrossTranslatePlane::m_Gizmo[3]
protected

Segments gizmo.

Definition at line 171 of file albaGizmoCrossTranslatePlane.h.

◆ m_InputVme

albaVME* albaGizmoCrossTranslatePlane::m_InputVme
protected

Register input vme.

Definition at line 174 of file albaGizmoCrossTranslatePlane.h.

Referenced by GetInput().

◆ m_ActivePlane

int albaGizmoCrossTranslatePlane::m_ActivePlane
protected

Register the gizmo plane.

Definition at line 178 of file albaGizmoCrossTranslatePlane.h.

Referenced by GetPlane().

◆ m_Length

double albaGizmoCrossTranslatePlane::m_Length
protected

Register the gizmo square plane side length.

Definition at line 181 of file albaGizmoCrossTranslatePlane.h.

Referenced by GetSizeLength().

◆ m_Line

vtkLineSource* albaGizmoCrossTranslatePlane::m_Line[2]
protected

Line source.

Definition at line 184 of file albaGizmoCrossTranslatePlane.h.

◆ m_LineTF

vtkTubeFilter* albaGizmoCrossTranslatePlane::m_LineTF[2]
protected

Tube filter for lines.

Definition at line 187 of file albaGizmoCrossTranslatePlane.h.

◆ m_RotatePDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_RotatePDF[3]
protected

rotate PDF for gizmo parts

Definition at line 190 of file albaGizmoCrossTranslatePlane.h.

◆ m_RotationTr

vtkTransform* albaGizmoCrossTranslatePlane::m_RotationTr
protected

rotation transform for cylinder and cone

Definition at line 193 of file albaGizmoCrossTranslatePlane.h.

◆ m_IsaComp

albaInteractorCompositorMouse* albaGizmoCrossTranslatePlane::m_IsaComp[2]
protected

isa compositor

Definition at line 205 of file albaGizmoCrossTranslatePlane.h.

◆ m_IsaGen

albaInteractorGenericMouse* albaGizmoCrossTranslatePlane::m_IsaGen[2]
protected

isa generic

Definition at line 208 of file albaGizmoCrossTranslatePlane.h.

◆ m_PivotTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_PivotTransform
protected

Used by albaInteractorGenericMouse.

Definition at line 211 of file albaGizmoCrossTranslatePlane.h.

◆ m_Listener

albaObserver* albaGizmoCrossTranslatePlane::m_Listener
protected

Register the event receiver object.

Definition at line 215 of file albaGizmoCrossTranslatePlane.h.

Referenced by SetListener().

◆ m_IsActive

bool albaGizmoCrossTranslatePlane::m_IsActive
protected

Register Gizmo status.

Definition at line 218 of file albaGizmoCrossTranslatePlane.h.

Referenced by GetIsActive(), and SetIsActive().

◆ m_TranslationFeedbackGizmo

albaVMEGizmo* albaGizmoCrossTranslatePlane::m_TranslationFeedbackGizmo
protected

Translation feedback arrows gizmo.

Definition at line 221 of file albaGizmoCrossTranslatePlane.h.

◆ m_FeedbackConeSource

vtkConeSource* albaGizmoCrossTranslatePlane::m_FeedbackConeSource
protected

Definition at line 223 of file albaGizmoCrossTranslatePlane.h.

◆ m_LeftFeedbackConeTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_LeftFeedbackConeTransform
protected

Definition at line 225 of file albaGizmoCrossTranslatePlane.h.

◆ m_RightFeedbackConeTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_RightFeedbackConeTransform
protected

Definition at line 226 of file albaGizmoCrossTranslatePlane.h.

◆ m_UpFeedbackConeTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_UpFeedbackConeTransform
protected

Definition at line 227 of file albaGizmoCrossTranslatePlane.h.

◆ m_DownFeedbackConeTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_DownFeedbackConeTransform
protected

Definition at line 228 of file albaGizmoCrossTranslatePlane.h.

◆ m_LeftFeedbackConeTransformPDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_LeftFeedbackConeTransformPDF
protected

Definition at line 230 of file albaGizmoCrossTranslatePlane.h.

◆ m_RightFeedbackConeTransformPDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_RightFeedbackConeTransformPDF
protected

Definition at line 231 of file albaGizmoCrossTranslatePlane.h.

◆ m_UpFeedbackConeTransformPDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_UpFeedbackConeTransformPDF
protected

Definition at line 232 of file albaGizmoCrossTranslatePlane.h.

◆ m_DownFeedbackConeTransformPDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_DownFeedbackConeTransformPDF
protected

Definition at line 233 of file albaGizmoCrossTranslatePlane.h.

◆ m_FeedbackCylinderSource

vtkCylinderSource* albaGizmoCrossTranslatePlane::m_FeedbackCylinderSource
protected

Definition at line 235 of file albaGizmoCrossTranslatePlane.h.

◆ m_HorizontalFeedbackCylinderTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_HorizontalFeedbackCylinderTransform
protected

Definition at line 237 of file albaGizmoCrossTranslatePlane.h.

◆ m_VerticalFeedbackCylinderTransform

vtkTransform* albaGizmoCrossTranslatePlane::m_VerticalFeedbackCylinderTransform
protected

Definition at line 238 of file albaGizmoCrossTranslatePlane.h.

◆ m_VerticalFeedbackCylinderTransformPDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_VerticalFeedbackCylinderTransformPDF
protected

Definition at line 240 of file albaGizmoCrossTranslatePlane.h.

◆ m_HorizontalFeedbackCylinderTransformPDF

vtkTransformPolyDataFilter* albaGizmoCrossTranslatePlane::m_HorizontalFeedbackCylinderTransformPDF
protected

Definition at line 241 of file albaGizmoCrossTranslatePlane.h.

◆ m_FeedbackStuffAppendPolydata

vtkAppendPolyData* albaGizmoCrossTranslatePlane::m_FeedbackStuffAppendPolydata
protected

Definition at line 243 of file albaGizmoCrossTranslatePlane.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.5