Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Protected Member Functions | Static Protected Member Functions
NIS_View Class Reference

#include <NIS_View.hxx>

Inheritance diagram for NIS_View:
Inheritance graph
[legend]

Public Member Functions

 NIS_View (const Handle_V3d_Viewer &theViewer, const Handle_Aspect_Window &theWindow=NULL)
void SetWindow (const Handle_Aspect_Window &theWindow)
void SetHilightOnTop (const Standard_Boolean theTop=Standard_True)
void SetDynHilightSelected (const Standard_Boolean theHilight=Standard_True)
Standard_Boolean FitAll3d (const Quantity_Coefficient theCoef=0.01)
Bnd_B3f GetBndBox () const
void GetBndBox (Standard_Integer &theXMin, Standard_Integer &theXMax, Standard_Integer &theYMin, Standard_Integer &theYMax) const
void DynamicHilight (const Standard_Integer theX, const Standard_Integer theY)
void DynamicUnhilight (const Handle_NIS_InteractiveObject &)
void DynamicUnhilight ()
void Select (const Standard_Integer theX, const Standard_Integer theY, const Standard_Boolean isForceMult=Standard_False, const Standard_Boolean theRedraw=Standard_True)
void Select (const Standard_Integer theXmin, const Standard_Integer theYmin, const Standard_Integer theXmax, const Standard_Integer theYmax, const Standard_Boolean isForceMult=Standard_False, const Standard_Boolean isFullyIncluded=Standard_False, const Standard_Boolean theRedraw=Standard_True)
void Select (const NCollection_List< gp_XY > &thePolygon, const Standard_Boolean isForceMult=Standard_False, const Standard_Boolean isFullyIncluded=Standard_False, const Standard_Boolean theRedraw=Standard_True)
Handle_NIS_InteractiveObject Pick (const Standard_Integer theX, const Standard_Integer theY)
Handle_NIS_InteractiveObject Pick (const gp_Ax1 &theAxis, const Standard_Real theOver, const Standard_Boolean isOnlySel)
NCollection_Vector
< NIS_InteractiveObject * > 
GetDetected () const
TColStd_PackedMapOfIntegerGetExListId ()

Protected Member Functions

void AddContext (NIS_InteractiveContext *)
void RemoveContext (NIS_InteractiveContext *)

Static Protected Member Functions

static int MyCallback (Aspect_Drawable, void *, Aspect_GraphicCallbackStruct *)

Detailed Description

Manager of a single window with OpenGL context, used by one or more NIS_InteractiveContext instances. This class inherits V3d_OrthograpicView therefore its instances can be used to display any object that is normally handled by Graphic3d/V3d/AIS classes. Also the standard view operations: Pan, Rotate, Zoom, mouse API, etc. are supported due to this inheritance.

The new services added by this class is the visualisation of NIS_InteractiveObject (i.e., accommodation of NIS_InteractiveContext instances). This visualisation is done by the method MyCallback that is called just before redrawing the scene by Graphic3d/OpenGl drivers.

The View instance can be understood as a collector of several interactive contexts that exist independently (do not interfere) though they output into the same OpenGL context. The contexts are:

The list of associated NIS_InteractiveContext can be modified by methods AddContext and RemoveContext.


Constructor & Destructor Documentation

NIS_View::NIS_View ( const Handle_V3d_Viewer &  theViewer,
const Handle_Aspect_Window &  theWindow = NULL 
)

Attach the view to the window.


Member Function Documentation

Register an interactive context for this view.

Destructor. Set or unset the dynamically hilighted object, depending on the given mouse coordinates.

void NIS_View::DynamicUnhilight ( const Handle_NIS_InteractiveObject &  )

Unhilights the hilighted object if it coincides with the given object instance.

Unhilights the currently hilighted object.

Zoom the view to fit to visible objects size and positions.

Parameters:
theCoefRelative margin in both X and Y dimensions. For example, value 1.0 will fit to twice the actual size.
Returns:
True if operation performed, False if failed (most likely because of very big actual scale)

Gets bounding box covering objects displayed in viewer.

void NIS_View::GetBndBox ( Standard_Integer theXMin,
Standard_Integer theXMax,
Standard_Integer theYMin,
Standard_Integer theYMax 
) const

Gets bounding box covering objects displayed in viewer. If operation is fails when Xmax < Xmin abd Ymax < Ymin

Gets all objects detected by last call of Pick() method

Obtain the IDs of ex-lists.

static int NIS_View::MyCallback ( Aspect_Drawable  ,
void ,
Aspect_GraphicCallbackStruct  
) [static, protected]
Handle_NIS_InteractiveObject NIS_View::Pick ( const Standard_Integer  theX,
const Standard_Integer  theY 
)

Interactive selection by mouse click. Selection itself is performed in each Interactive Context attached to this View, accordingto the local parameters (mode, filter) of selection in each context.

Parameters:
theXX coordinate of mouse pointer in the window.
theYY coordinate of mouse pointer in the window.
Returns:
the selected object picked by the minimal intersection distance among all contexts attached to this View.
Handle_NIS_InteractiveObject NIS_View::Pick ( const gp_Ax1 theAxis,
const Standard_Real  theOver,
const Standard_Boolean  isOnlySel 
)

Interactive selection by mouse click. Selection itself is performed in each Interactive Context attached to this View, accordingto the local parameters (mode, filter) of selection in each context.

Parameters:
theAxis3D axis for objects selection
theOverOverlap for the selecting axis
isOnlySelIf False, any displayed object can be picked, otherwise only selectable ones.
Returns:
the selected object picked by the minimal intersection distance among all contexts attached to this View.

Detach an interactive context from this view.

Set or unset the selected (hilighted) state of the object that is under the coordinates theX, theY.

Parameters:
theXX coordinate of the view window
theYX coordinate of the view window
isForceMultTrue if the effect of multi-Selection should be forced (e.g., when Shift is pressed).
theRedrawTrue to redraw view automatically (default value).

Set or unset the selected (hilighted) state of the objects that are intersected by 2D box in the view

Parameters:
theXminleft X coordinate of the view window
theYminlower Y coordinate of the view window
theXmaxright X coordinate of the view window
theYmaxupper Y coordinate of the view window
isForceMultTrue if the effect of multi-Selection should be forced (e.g., when Shift is pressed).
isFullyIncludedTrue if only those objects are processed that are fully inside the selection rectangle. False if objects fully or partially included in the rectangle are processed.
theRedrawTrue to redraw view automatically (default value).

Set or unset the selected (hilighted) state of the objects that are intersected by 2D polygon in the view

Parameters:
thePolygondefines the vertices of a free-form closed polygon without self-intersections. The last point should not coincide with the first point of the list. Points are interpreted as X and Y integer coordinates of the view window. Any two neighbor points should not be confused.
isForceMultTrue if the effect of multi-Selection should be forced (e.g., when Shift is pressed).
isFullyIncludedTrue if only those objects are processed that are fully inside the selection rectangle. False if objects fully or partially included in the rectangle are processed.
theRedrawTrue to redraw view automatically (default value).

Indicate whether to hilight selected object dynamically By default dynamic hilight works on all objects independently on its selected/non-selected state. This behaviour differs from the behaviour of AIS interactive context, that doesn't hilight dynamically (on mouse movements) selected objects. In the case both context are used in the same view the behaviour of both context can be made consistent by setting this flag to False

Indicate whether to draw hilighted objects on top of all other ones

void NIS_View::SetWindow ( const Handle_Aspect_Window &  theWindow)

Attach the view to the window.


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