HOpConstructRectangle Class Reference

The HOpConstructRectangle class draws a rectangle. More...

#include <HOpConstructRectangle.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpConstructRectangle (HBaseView *view, int DoRepeat=0, int DoCapture=1, bool UseCenterMarker=true)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (HEventInfo &hevent)
 
virtual int OnRButtonUp (HEventInfo &hevent)
 
- 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 OnLButtonDblClk (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 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.
 

Protected Attributes

bool m_bRectangleExists
 
char m_pSavedColor [MVO_BUFFER_SIZE]
 
char m_pSavedVisibility [MVO_BUFFER_SIZE]
 
HPoint m_ptRectangle [2]
 
- 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
 

Additional Inherited Members

- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 

Detailed Description

The HOpConstructRectangle class draws a rectangle.

HOpConstructRectangle implements three of the mouse button event handlers and uses the event information to draw a rectangle. This provides the basic functionality for drawing a temporary, overlayed 2-D box outline in the view plane based on first and last pointer positions. The operation consists of the following steps:

  1. Left Button Down: Registers the first point of the rectangle.
  2. Left Button Down and Drag: Rubberbands the rectangle to the desired dimensions.
  3. Left Button Up: The rectangle finalized and the polyline primitive used to represent the rectangle is flushed from the scene.

More Detailed Description: see event methods.

Constructor & Destructor Documentation

◆ HOpConstructRectangle()

HOpConstructRectangle::HOpConstructRectangle ( HBaseView view,
int  DoRepeat = 0,
int  DoCapture = 1,
bool  UseCenterMarker = true 
)

Constructs an HOpConstructRectangle 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.
UseCenterMarkerPass true if you want HOOPS to render a mark at the center of the rectangle.

Member Function Documentation

◆ Clone()

virtual HBaseOperator* HOpConstructRectangle::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 HOpConstructRectangle object.

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraZoomBox, HOpSelectArea, HOpCreateRectangle, HOpSelectAreaOOC< SelectionSet >, and HOpMarkupRectangle.

◆ GetName()

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

Reimplemented from HBaseOperator.

Reimplemented in HOpCameraZoomBox, HOpCreateRectangle, HOpSelectArea, HOpSelectAreaOOC< SelectionSet >, and HOpMarkupRectangle.

◆ OnLButtonDown()

virtual int HOpConstructRectangle::OnLButtonDown ( HEventInfo hevent)
virtual

OnLButtonDown records the first mouse position and initiates the rectangle-drawing 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 HOpSelectAreaOOC< SelectionSet >, and HOpSelectArea.

◆ OnLButtonDownAndMove()

virtual int HOpConstructRectangle::OnLButtonDownAndMove ( HEventInfo hevent)
virtual

OnLButtonDownAndMove draws a rubberbanded line from the first point in the rectangle to the current mouse position. Note that the basic drawing work is done by HUtility::InsertRectangle, while OnLButtonDownAndMove keeps track of the current points and draws the rubberband centroid.

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

Reimplemented from HBaseOperator.

◆ OnLButtonUp()

virtual int HOpConstructRectangle::OnLButtonUp ( HEventInfo hevent)
virtual

OnLButtonUp finalizes the size of the rectangle and cleans up.

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

Reimplemented from HBaseOperator.

Reimplemented in HOpSelectAreaOOC< SelectionSet >, HOpSelectArea, HOpCreateRectangle, HOpCameraZoomBox, and HOpMarkupRectangle.

◆ OnRButtonUp()

virtual int HOpConstructRectangle::OnRButtonUp ( HEventInfo hevent)
virtual

OnRButtonUp passes a right-button up event to OnLButtonUp.

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

Reimplemented from HBaseOperator.

Member Data Documentation

◆ m_bRectangleExists

bool HOpConstructRectangle::m_bRectangleExists
protected

The boolean indicating whether the rectangle exists.

◆ m_ptRectangle

HPoint HOpConstructRectangle::m_ptRectangle[2]
protected

The first and last points in the rectangle stored in window space.

Referenced by HOpSelectAreaOOC< SelectionSet >::OnLButtonUp().


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