The HOpObjectTranslate class translates a selected object. More...

#include <HOpObjectTranslate.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpObjectTranslate (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDblClk (HEventInfo &hevent)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
virtual void UpdateKeyList (void *data)
 
- Public Member Functions inherited from HBaseOperator
int Capture ()
 Returns whether we are currently in mouse capture mode. See this class' constructor for a more detailed description of what this means. This method has been deprecated.
 
HPoint const GetFirstPoint ()
 Returns the initial selection point.
 
HPoint const GetNewPoint ()
 Returns the current selection point.
 
HBaseViewGetView ()
 Returns a pointer to the view that this operator is associated with.
 
 HBaseOperator (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnKeyDown (HEventInfo &hevent)
 
virtual int OnKeyUp (HEventInfo &hevent)
 
virtual int OnLRButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnMButtonDblClk (HEventInfo &hevent)
 
virtual int OnMButtonDown (HEventInfo &hevent)
 
virtual int OnMButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnMButtonUp (HEventInfo &hevent)
 
virtual int OnMouseMove (HEventInfo &hevent)
 
virtual int OnMouseWheel (HEventInfo &hevent)
 
virtual int OnNoButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnRButtonDblClk (HEventInfo &hevent)
 
virtual int OnRButtonDown (HEventInfo &hevent)
 
virtual int OnRButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnRButtonUp (HEventInfo &hevent)
 
virtual int OnTimer (HEventInfo &hevent)
 
virtual int OnTouchesDown (HEventInfo &hevent)
 
virtual int OnTouchesMove (HEventInfo &hevent)
 
virtual int OnTouchesUp (HEventInfo &hevent)
 
virtual bool OperatorStarted ()
 Operator has been started if true, and has not been started if false.
 
int Repeat ()
 Returns whether the operation is repeatable. This method has been deprecated.
 
void SetFirstPoint (HPoint const &new_point)
 Sets the initial selection point.
 
void SetMapTouchesToMouseEvents (bool val)
 Touch Events are mapped to mouse events if true, and are not if false.
 
void SetNewPoint (HPoint const &new_point)
 Sets the current selection point.
 
void SetOperatorStarted (bool val)
 Operator has been started if true, and has not been started if false.
 
void SetView (HBaseView *new_view)
 Sets the view that this operator is associated with.
 

Public Attributes

HPoint m_ptRecent
 
HPoint m_ptRecentVP
 

Protected Member Functions

void Cleanup ()
 
int GetMatrix (HEventInfo &hevent, int key_count, HC_KEY const *full_path_keys, float matrix_out[])
 
void Init ()
 
int UpdateMousePos (HEventInfo &hevent)
 
- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 

Protected Attributes

bool m_bInitialMatrix
 
bool m_bTemporarySelection
 
HKeyList * m_KeyList
 
HPoint m_ptLast
 
- Protected Attributes inherited from HBaseOperator
bool m_bMapTouchesToMouseEvents
 Indicates if touch events are mapped to mouse events.
 
bool m_bOpStarted
 Indicates whether the operator has already 'started'. More...
 
int m_doCapture
 Integer indicating whether to capture mouse on button down and release on button up. This parameter has been deprecated.
 
int m_doRepeat
 Integer indicating if the operator is repeatable . This parameter has been deprecated.
 
HPoint m_ptFirst
 Initial selection point.
 
HPoint m_ptNew
 Current selection point.
 
HBaseViewm_pView
 The HOOPS view corresponding to this operator.
 
HCutGeometryVisibility m_TempCutGeometryVisibility
 stores original cut geometry visibility
 
HShadowMode m_TempShadowMode
 stores original shadow mode
 

Detailed Description

The HOpObjectTranslate class translates a selected object.

HOpObjectTranslates implements three of the mouse event handlers defined on the base class and maps the event information to HOOPS routines which translates the currently selected objects. This provides the basic functionality for applying a translation transform to an object (as opposed to a global panning of the camera which affects the entire scene). The operation consists of the following steps:

  1. Left Button Down: The operation is initiated and an object is selected.
  2. Left Button Down and Drag: The object is translated using spriting.
  3. Left Button Up: The translation is finalized and the operation ends.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpObjectTranslate()

HOpObjectTranslate::HOpObjectTranslate ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1 
)

Constructs an HOpObjectTranslate object.

Parameters
viewA pointer to an HBaseView object,
DoRepeatAn integer denoting whether this is a repeatable operator. This parameter has been deprecated.
DoCaptureAn integer denoting whether the mouse state should be captured, which means that all mouse events should be received after a mousedown, even if it leaves the window. This parameter has been deprecated.

Member Function Documentation

◆ Cleanup()

void HOpObjectTranslate::Cleanup ( )
protected

This method cleans up the selected entities and turns off spriting if appropriate.

◆ Clone()

virtual HBaseOperator* HOpObjectTranslate::Clone ( )
virtual

Creates a new operator which is a copy of the current operator. The user is responsible for deleting the newly created operator.

Returns
A pointer to the newly created HOpObjectTranslate object.

Reimplemented from HBaseOperator.

Reimplemented in HOpObjectClash, and HOpCreateCuttingPlane.

◆ GetMatrix()

int HOpObjectTranslate::GetMatrix ( HEventInfo hevent,
int  key_count,
HC_KEY const *  full_path_keys,
float  matrix_out[] 
)
protected

For internal use only. This method does the computation work to compose a translation matrix that makes objects follow the mouse pointer. It copies the matrix contents into matrix_out so that they may be applied to arbitrary targets. It takes key as an argument because the required transformation can depend on segments' pre-existing modelling matrices. Currently, it assumes that the input key is a segment.

Parameters
heventAn HEventInfo object containing information about the current event.
key_countThe number of keys in the full segment path.
full_path_keysThe keys of each segment in the full segment path.
matrix_outA pointer to an array of 16 floats. Called by reference, returned to user.
Returns
An integer value indicating success or failure.

◆ GetName()

virtual const char* HOpObjectTranslate::GetName ( )
virtual
Returns
A pointer to a character string denoting the name of the operator which is 'HOpObjectTranslate'.

Reimplemented from HBaseOperator.

Reimplemented in HOpObjectClash, and HOpCreateCuttingPlane.

◆ Init()

void HOpObjectTranslate::Init ( )
protected

This method initializes the selected entities and turns on spriting.

◆ OnLButtonDblClk()

virtual int HOpObjectTranslate::OnLButtonDblClk ( HEventInfo hevent)
virtual

OnLButtonDblClk translates the object back to its original location.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

◆ OnLButtonDown()

virtual int HOpObjectTranslate::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown records the first pointer position and initializes the translation mechanism.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

Reimplemented in HOpObjectClash, and HOpCreateCuttingPlane.

◆ OnLButtonDownAndMove()

virtual int HOpObjectTranslate::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove computes the translation transform based on the distance between the first and current pointer positions, and translates the object accordingly.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

Reimplemented in HOpObjectClash.

◆ OnLButtonUp()

virtual int HOpObjectTranslate::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp cleans up the construction segments used during the transformation and ends the operation.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An HOperatorReturn indicating the status of the event.

Reimplemented from HBaseOperator.

Reimplemented in HOpObjectClash, and HOpCreateCuttingPlane.

◆ UpdateKeyList()

virtual void HOpObjectTranslate::UpdateKeyList ( void *  data)
virtual

This method is used to update the list of keys to translate when the selection list changes.

Reimplemented in HOpObjectClash.

◆ UpdateMousePos()

int HOpObjectTranslate::UpdateMousePos ( HEventInfo hevent)
protected

For internal use only. This method updates the internal state needed for matrix calculations.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
An integer value indicating success or failure.

Member Data Documentation

◆ m_bInitialMatrix

bool HOpObjectTranslate::m_bInitialMatrix
protected

The initial modelling matrix.

◆ m_bTemporarySelection

bool HOpObjectTranslate::m_bTemporarySelection
protected

This boolean indicates whether object was temporarily selected.

◆ m_KeyList

HKeyList* HOpObjectTranslate::m_KeyList
protected

A List of keys to translate (copied from selection set).

◆ m_ptRecent

HPoint HOpObjectTranslate::m_ptRecent

A pointer to the current position in world coordinates.

◆ m_ptRecentVP

HPoint HOpObjectTranslate::m_ptRecentVP

A pointer to the current position in viewpoint (screen) coordinates.


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