HOpSelectPolyline Class Reference

The HOpSelectPolyline class computes a selection list for objects intersected by a user-defined polyline. More...

#include <HOpSelectPolyline.h>

Public Member Functions

virtual HBaseOperatorClone ()
 
virtual const char * GetName ()
 
 HOpSelectPolyline (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDblClk (HEventInfo &hevent)
 
- Public Member Functions inherited from HOpConstructPolyline
 HOpConstructPolyline (HBaseView *view, int DoRepeat=0, int DoCapture=1)
 
virtual int OnLButtonDown (HEventInfo &hevent)
 
virtual int OnNoButtonDownAndMove (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 OnLButtonDownAndMove (HEventInfo &hevent)
 
virtual int OnLButtonUp (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 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.
 

Additional Inherited Members

- Public Attributes inherited from HOpConstructPolyline
HC_KEY m_PolylineKey
 
- Protected Member Functions inherited from HBaseOperator
bool IsSpecialKey (HC_KEY key)
 
- Protected Attributes inherited from HOpConstructPolyline
int m_PolylineCount
 
HPointm_pPolyline
 
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 HOpSelectPolyline class computes a selection list for objects intersected by a user-defined polyline.

HOpSelectPolyline employs all of the drawing functionality of HOpConstructPolyline to define a temporary, overlayed polyline, then maps the polyline to the HOOPS routine HC_Compute_Selection_By_Polylin. This provides the basic functionality for selecting a group of objects based on their intersection with a line. The operation consists of the following steps:

  1. Left Button Down: operation initiated, first point of the polyline recorded
  2. No Button Down and Drag: rubberband line segment to desired position of next point
  3. Left Button Down: next point in polyline recorded, etc.
  4. Left Button Double Click: polyline completed and flushed from scene, selection list computed, objects highlighted, operation ended

More Detailed Description: see event methods Functional Note: This operator does not provide exact results for HOOPS' Shell and Mesh primitives.

Constructor & Destructor Documentation

◆ HOpSelectPolyline()

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

Constructs an HOpSelectPolyline 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

◆ Clone()

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

Reimplemented from HOpConstructPolyline.

◆ GetName()

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

Reimplemented from HOpConstructPolyline.

◆ OnLButtonDblClk()

virtual int HOpSelectPolyline::OnLButtonDblClk ( HEventInfo hevent)
virtual

returns a pointer to a copy of the operator

OnLButtonDblClk passes the polyline array from HOpConstructPolyline::OnLButtonDblClk into the HOOPS routine HC_Compute_Selection_By_Polyline. Currently selected items are highlighted, and items previously highlighted are de-selected.

Parameters
heventAn HEventInfo object containing information about the current event.
Returns
A value indicating the result of the event handling.

Reimplemented from HOpConstructPolyline.


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