#include <NIS_View.hxx>

Inheritance diagram for NIS_View:

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_PackedMapOfInteger &	GetExListId ()

Public Member Functions inherited from V3d_View
	V3d_View (const Handle< V3d_Viewer > &VM, const V3d_TypeOfView Type=V3d_ORTHOGRAPHIC)
	Initializes the view. More...

	V3d_View (const Handle< V3d_Viewer > &theVM, const Handle< V3d_View > &theView)
	Initializes the view by copying. More...

void	SetWindow (const Handle< Aspect_Window > &IdWin)
	Activates the view in the window specified and Map the Window to the screen. Warning! raises MultiplyDefined from Standard if the view is already activated in a window. Warning: The view is centered and resized to preserve the height/width ratio of the window. More...

void	SetWindow (const Handle< Aspect_Window > &aWindow, const Aspect_RenderingContext aContext, const Aspect_GraphicCallbackProc &aDisplayCB, const Standard_Address aClientData)
	Activates the view in the specified Window If <aContext> is not NULL the graphic context is used to draw something in this view. Otherwise an internal graphic context is created. If <aDisplayCB> is not NULL then a user display CB is call at the end of the OCC graphic traversal and just before the swap of buffers. The <aClientData> is pass to this call back. Warning! raises MultiplyDefined from Standard if the view is already activated in a window. Warning: The view is centered and resized to preserve the height/width ratio of the window. More...

void	SetMagnify (const Handle< Aspect_Window > &IdWin, const Handle< V3d_View > &aPreviousView, const Standard_Integer x1, const Standard_Integer y1, const Standard_Integer x2, const Standard_Integer y2)

void	Remove () const
	Destroys the view. More...

void	Update () const
	Deprecated, Redraw() should be used instead. More...

void	Redraw () const
	Redisplays the view even if there has not been any modification. Must be called if the view is shown. (Ex: DeIconification ) . More...

void	RedrawImmediate () const
	Updates layer of immediate presentations. More...

void	Invalidate () const
	Invalidates view content but does not redraw it. More...

void	Redraw (const Standard_Integer x, const Standard_Integer y, const Standard_Integer width, const Standard_Integer height) const
	Redisplays the view area after esxposure. [x,y] define the min xy area position [width,height] the size of the area in pixel unit. More...

void	MustBeResized ()
	Must be called when the window supporting the view changes size. if the view is not mapped on a window. Warning: The view is centered and resized to preserve the height/width ratio of the window. More...

void	DoMapping ()
	Must be called when the window supporting the view is mapped or unmapped. More...

Standard_Boolean	IsEmpty () const
	Returns the status of the view regarding the displayed structures inside Returns True is The View is empty. More...

void	UpdateLights () const
	Updates the lights of the view. The view is redrawn. More...

void	AutoZFit ()
	If automatic z-range fitting is turned on, adjusts Z-min and Z-max projection volume planes with call to ZFitAll. More...

void	ZFitAll (const Standard_Real theScaleFactor=1.0)
	Change Z-min and Z-max planes of projection volume to match the displayed objects. More...

void	SetBackgroundColor (const Quantity_TypeOfColor Type, const Quantity_Parameter V1, const Quantity_Parameter V2, const Quantity_Parameter V3)
	Defines the background colour of the view by supplying : the colour definition type, and the three corresponding values. More...

void	SetBackgroundColor (const Quantity_Color &Color)
	Defines the background colour of the view by supplying : the colour object. More...

void	SetBackgroundColor (const Quantity_NameOfColor Name)
	Defines the background colour of the view by supplying : the colour name in the form Quantity_NOC_xxxx . More...

void	SetBgGradientColors (const Quantity_Color &Color1, const Quantity_Color &Color2, const Aspect_GradientFillMethod FillStyle=Aspect_GFM_HOR, const Standard_Boolean update=Standard_False)
	Defines the gradient background colours of the view by supplying : two colour objects, and fill method (horizontal by default) More...

void	SetBgGradientColors (const Quantity_NameOfColor Color1, const Quantity_NameOfColor Color2, const Aspect_GradientFillMethod FillStyle=Aspect_GFM_HOR, const Standard_Boolean update=Standard_False)
	Defines the gradient background colours of the view by supplying : two colour names in the form Quantity_NOC_xxxx, and fill method (horizontal by default) More...

void	SetBgGradientStyle (const Aspect_GradientFillMethod AMethod=Aspect_GFM_HOR, const Standard_Boolean update=Standard_False)
	Defines the gradient background fill method of the view. More...

void	SetBackgroundImage (const Standard_CString FileName, const Aspect_FillMethod FillStyle=Aspect_FM_CENTERED, const Standard_Boolean update=Standard_False)
	Defines the background texture of the view by supplying : texture image file name, and fill method (centered by default) More...

void	SetBgImageStyle (const Aspect_FillMethod FillStyle, const Standard_Boolean update=Standard_False)
	Defines the textured background fill method of the view. More...

void	SetAxis (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Quantity_Parameter Vx, const Quantity_Parameter Vy, const Quantity_Parameter Vz)
	Definition of an axis from its origin and its orientation . This will be the current axis for rotations and movements. Warning! raises BadValue from V3d if the vector normal is NULL. . More...

void	SetShadingModel (const V3d_TypeOfShadingModel Model)
	Defines the shading model for the visualisation ZBUFFER mode. Various models are available. More...

void	SetSurfaceDetail (const V3d_TypeOfSurfaceDetail SurfaceDetail)
	select the kind of rendering for texture mapping no texture mapping by default More...

void	SetTextureEnv (const Handle< Graphic3d_TextureEnv > &ATexture)
	set the environment texture to use no environment texture by default More...

void	SetVisualization (const V3d_TypeOfVisualization Mode)
	Defines the visualisation mode in the view. More...

void	SetAntialiasingOn ()
	Activates antialiasing in the view. More...

void	SetAntialiasingOff ()
	Desactivates antialiasing in the view. More...

void	SetZClippingDepth (const Quantity_Length Depth)
	Defines the depth of the medium clipping plane. More...

void	SetZClippingWidth (const Quantity_Length Width)
	Defines the thicknes around the medium clippling plane. . More...

void	SetZClippingType (const V3d_TypeOfZclipping Type)
	Defines the type of ZClipping. More...

void	SetZCueingDepth (const Quantity_Length Depth)
	Defines the depth of the medium plane. More...

void	SetZCueingWidth (const Quantity_Length Width)
	Defines the thickness around the medium plane. More...

void	SetZCueingOn ()
	Activates ZCueing in the view. More...

void	SetZCueingOff ()
	Desactivates ZCueing in the view. More...

void	SetLightOn (const Handle< V3d_Light > &MyLight)
	Activates MyLight in the view. More...

void	SetLightOn ()
	Activates all the lights defined in this view. More...

void	SetLightOff (const Handle< V3d_Light > &MyLight)
	Desactivate MyLight in this view. More...

void	SetLightOff ()
	Deactivate all the Lights defined in this view. More...

Standard_Boolean	IsActiveLight (const Handle< V3d_Light > &aLight) const
	Returns TRUE when the light is active in this view. More...

Standard_Boolean	SetImmediateUpdate (const Standard_Boolean theImmediateUpdate)
	sets the immediate update mode and returns the previous one. More...

void	ZBufferTriedronSetup (const Quantity_NameOfColor XColor=Quantity_NOC_RED, const Quantity_NameOfColor YColor=Quantity_NOC_GREEN, const Quantity_NameOfColor ZColor=Quantity_NOC_BLUE1, const Standard_Real SizeRatio=0.8, const Standard_Real AxisDiametr=0.05, const Standard_Integer NbFacettes=12)
	Customization of the ZBUFFER Triedron. XColor,YColor,ZColor - colors of axis SizeRatio - ratio of decreasing of the trihedron size when its phisical position comes out of the view AxisDiametr - diameter relatively to axis length NbFacettes - number of facettes of cylinders and cones. More...

void	TriedronDisplay (const Aspect_TypeOfTriedronPosition APosition=Aspect_TOTP_CENTER, const Quantity_NameOfColor AColor=Quantity_NOC_WHITE, const Standard_Real AScale=0.02, const V3d_TypeOfVisualization AMode=V3d_WIREFRAME)
	Display of the Triedron. Initialize position, color and length of Triedron axes. The scale is a percent of the window width. More...

void	TriedronErase ()
	Erases the Triedron. More...

void	TriedronEcho (const Aspect_TypeOfTriedronEcho AType=Aspect_TOTE_NONE)
	Highlights the echo zone of the Triedron. More...

const Graphic3d_GraduatedTrihedron &	GetGraduatedTrihedron () const
	Returns data of a graduated trihedron. More...

void	GraduatedTrihedronDisplay (const Graphic3d_GraduatedTrihedron &theTrigedronData)
	Displays a graduated trihedron. More...

void	GraduatedTrihedronErase ()
	Erases a graduated trihedron from the view. More...

void	SetLayerMgr (const Handle< V3d_LayerMgr > &aMgr)

void	ColorScaleDisplay ()

void	ColorScaleErase ()

Standard_Boolean	ColorScaleIsDisplayed () const

Handle< Aspect_ColorScale >	ColorScale () const

void	SetFront ()
	modify the Projection of the view perpendicularly to the privileged plane of the viewer. More...

void	Rotate (const Quantity_PlaneAngle Ax, const Quantity_PlaneAngle Ay, const Quantity_PlaneAngle Az, const Standard_Boolean Start=Standard_True)
	Rotates the eye about the coordinate system of reference of the screen for which the origin is the view point of the projection, with a relative angular value in RADIANS with respect to the initial position expressed by Start = Standard_True Warning! raises BadValue from V3d If the eye, the view point, or the high point are aligned or confused. More...

void	Rotate (const Quantity_PlaneAngle Ax, const Quantity_PlaneAngle Ay, const Quantity_PlaneAngle Az, const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Standard_Boolean Start=Standard_True)
	Rotates the eye about the coordinate system of reference of the screen for which the origin is Gravity point {X,Y,Z}, with a relative angular value in RADIANS with respect to the initial position expressed by Start = Standard_True If the eye, the view point, or the high point are aligned or confused. More...

void	Rotate (const V3d_TypeOfAxe Axe, const Quantity_PlaneAngle Angle, const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, const Standard_Boolean Start=Standard_True)
	Rotates the eye about one of the coordinate axes of of the view for which the origin is the Gravity point{X,Y,Z} with an relative angular value in RADIANS with respect to the initial position expressed by Start = Standard_True. More...

void	Rotate (const V3d_TypeOfAxe Axe, const Quantity_PlaneAngle Angle, const Standard_Boolean Start=Standard_True)
	Rotates the eye about one of the coordinate axes of of the view for which the origin is the view point of the projection with an relative angular value in RADIANS with respect to the initial position expressed by Start = Standard_True. More...

void	Rotate (const Quantity_PlaneAngle Angle, const Standard_Boolean Start=Standard_True)
	Rotates the eye around the current axis a relative angular value in RADIANS with respect to the initial position expressed by Start = Standard_True. More...

void	Move (const Quantity_Length Dx, const Quantity_Length Dy, const Quantity_Length Dz, const Standard_Boolean Start=Standard_True)
	Movement of the eye parallel to the coordinate system of reference of the screen a distance relative to the initial position expressed by Start = Standard_True. More...

void	Move (const V3d_TypeOfAxe Axe, const Quantity_Length Length, const Standard_Boolean Start=Standard_True)
	Movement of the eye parallel to one of the axes of the coordinate system of reference of the view a distance relative to the initial position expressed by Start = Standard_True. More...

void	Move (const Quantity_Length Length, const Standard_Boolean Start=Standard_True)
	Movement of the eye parllel to the current axis a distance relative to the initial position expressed by Start = Standard_True. More...

void	Translate (const Quantity_Length Dx, const Quantity_Length Dy, const Quantity_Length Dz, const Standard_Boolean Start=Standard_True)
	Movement of the ye and the view point parallel to the frame of reference of the screen a distance relative to the initial position expressed by Start = Standard_True. More...

void	Translate (const V3d_TypeOfAxe Axe, const Quantity_Length Length, const Standard_Boolean Start=Standard_True)
	Movement of the eye and the view point parallel to one of the axes of the fame of reference of the view a distance relative to the initial position expressed by Start = Standard_True. More...

void	Translate (const Quantity_Length Length, const Standard_Boolean Start=Standard_True)
	Movement of the eye and view point parallel to the current axis a distance relative to the initial position expressed by Start = Standard_True. More...

void	Place (const Standard_Integer theXp, const Standard_Integer theYp, const Quantity_Factor theZoomFactor=1)
	places the point of the view corresponding at the pixel position x,y at the center of the window and updates the view. More...

void	Turn (const Quantity_PlaneAngle Ax, const Quantity_PlaneAngle Ay, const Quantity_PlaneAngle Az, const Standard_Boolean Start=Standard_True)
	Rotation of the view point around the frame of reference of the screen for which the origin is the eye of the projection with a relative angular value in RADIANS with respect to the initial position expressed by Start = Standard_True. More...

void	Turn (const V3d_TypeOfAxe Axe, const Quantity_PlaneAngle Angle, const Standard_Boolean Start=Standard_True)
	Rotation of the view point around one of the axes of the frame of reference of the view for which the origin is the eye of the projection with an angular value in RADIANS relative to the initial position expressed by Start = Standard_True. More...

void	Turn (const Quantity_PlaneAngle Angle, const Standard_Boolean Start=Standard_True)
	Rotation of the view point around the current axis an angular value in RADIANS relative to the initial position expressed by Start = Standard_True. More...

void	SetTwist (const Quantity_PlaneAngle Angle)
	Defines the angular position of the high point of the reference frame of the view with respect to the Y screen axis with an absolute angular value in RADIANS. More...

void	SetEye (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z)
	Defines the position of the eye.. More...

void	SetDepth (const Quantity_Length Depth)
	Defines the Depth of the eye from the view point without update the projection . More...

void	SetProj (const Quantity_Parameter Vx, const Quantity_Parameter Vy, const Quantity_Parameter Vz)
	Defines the orientation of the projection. More...

void	SetProj (const V3d_TypeOfOrientation Orientation)
	Defines the orientation of the projection . More...

void	SetAt (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z)
	Defines the position of the view point. More...

void	SetUp (const Quantity_Parameter Vx, const Quantity_Parameter Vy, const Quantity_Parameter Vz)
	Defines the orientation of the high point. More...

void	SetUp (const V3d_TypeOfOrientation Orientation)
	Defines the orientation(SO) of the high point. More...

void	SetViewOrientationDefault ()
	Saves the current state of the orientation of the view which will be the return state at ResetViewOrientation. More...

void	ResetViewOrientation ()
	Resets the orientation of the view. Updates the view. More...

void	Panning (const Standard_Real theDXv, const Standard_Real theDYv, const Quantity_Factor theZoomFactor=1, const Standard_Boolean theToStart=Standard_True)
	Translates the center of the view along "x" and "y" axes of view projection. Can be used to perform interactive panning operation. In that case the DXv, DXy parameters specify panning relative to the point where the operation is started. More...

void	SetCenter (const Standard_Integer theXp, const Standard_Integer theYp)
	Relocates center of screen to the point, determined by {Xp, Yp} pixel coordinates relative to the bottom-left corner of screen. To calculate pixel coordinates for any point from world coordinate space, it can be projected using "Project". More...

void	SetSize (const Quantity_Length theSize)
	Defines the view projection size in its maximum dimension, keeping the inital height/width ratio unchanged. More...

void	SetZSize (const Quantity_Length Size)
	Defines the Depth size of the view Front Plane will be set to Size/2. Back Plane will be set to -Size/2. Any Object located Above the Front Plane or behind the Back Plane will be Clipped . NOTE than the XY Size of the View is NOT modified . More...

void	SetZoom (const Quantity_Factor Coef, const Standard_Boolean Start=Standard_True)
	Zooms the view by a factor relative to the initial value expressed by Start = Standard_True Updates the view. More...

void	SetScale (const Quantity_Factor Coef)
	Zooms the view by a factor relative to the value initialised by SetViewMappingDefault(). Updates the view. More...

void	SetAxialScale (const Standard_Real Sx, const Standard_Real Sy, const Standard_Real Sz)
	Sets anisotropic (axial) scale factors <Sx>, <Sy>, <Sz> for view <me>. Anisotropic scaling operation is performed through multiplying the current view orientation matrix by a scaling matrix: \|\| Sx 0 0 0 \|\| \|\| 0 Sy 0 0 \|\| \|\| 0 0 Sz 0 \|\| \|\| 0 0 0 1 \|\| Updates the view. More...

void	FitAll (const Quantity_Coefficient theMargin=0.01, const Standard_Boolean theToUpdate=Standard_True)
	Adjust view parameters to fit the displayed scene, respecting height / width ratio. The Z clipping range (depth range) is fitted if AutoZFit flag is TRUE. Throws program error exception if margin coefficient is < 0 or >= 1. Updates the view. More...

void	FitAll (const Bnd_Box &theBox, const Quantity_Coefficient theMargin=0.01, const Standard_Boolean theToUpdate=Standard_True)
	Adjust view parameters to fit the displayed scene, respecting height / width ratio according to the custom bounding box given. Throws program error exception if margin coefficient is < 0 or >= 1. Updates the view. More...

void	DepthFitAll (const Quantity_Coefficient Aspect=0.01, const Quantity_Coefficient Margin=0.01)
	Adjusts the viewing volume so as not to clip the displayed objects by front and back and back clipping planes. Also sets depth value automatically depending on the calculated Z size and Aspect parameter. NOTE than the original XY size of the view is NOT modified . More...

void	FitAll (const Standard_Real theMinXv, const Standard_Real theMinYv, const Standard_Real theMaxXv, const Standard_Real theMaxYv)
	Centers the defined projection window so that it occupies the maximum space while respecting the initial height/width ratio. NOTE than the original Z size of the view is NOT modified . More...

void	WindowFit (const Standard_Integer theMinXp, const Standard_Integer theMinYp, const Standard_Integer theMaxXp, const Standard_Integer theMaxYp)
	Centers the defined PIXEL window so that it occupies the maximum space while respecting the initial height/width ratio. NOTE than the original Z size of the view is NOT modified. More...

void	SetViewMappingDefault ()
	Saves the current view mapping. This will be the state returned from ResetViewmapping. More...

void	ResetViewMapping ()
	Resets the centering of the view. Updates the view. More...

void	Reset (const Standard_Boolean update=Standard_True)
	Resets the centering and the orientation of the view Updates the view. More...

Quantity_Length	Convert (const Standard_Integer Vp) const
	Converts the PIXEL value to a value in the projection plane. More...

void	Convert (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate &Xv, V3d_Coordinate &Yv) const
	Converts the point PIXEL into a point projected in the reference frame of the projection plane. More...

Standard_Integer	Convert (const Quantity_Length Vv) const
	Converts tha value of the projection plane into a PIXEL value. More...

void	Convert (const V3d_Coordinate Xv, const V3d_Coordinate Yv, Standard_Integer &Xp, Standard_Integer &Yp) const
	Converts the point defined in the reference frame of the projection plane into a point PIXEL. More...

void	Convert (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
	Converts the projected point into a point in the reference frame of the view corresponding to the intersection with the projection plane of the eye/view point vector. More...

void	ConvertWithProj (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z, Quantity_Parameter &Vx, Quantity_Parameter &Vy, Quantity_Parameter &Vz) const
	Converts the projected point into a point in the reference frame of the view corresponding to the intersection with the projection plane of the eye/view point vector and returns the projection ray for further computations. More...

void	ConvertToGrid (const Standard_Integer Xp, const Standard_Integer Yp, V3d_Coordinate &Xg, V3d_Coordinate &Yg, V3d_Coordinate &Zg) const
	Converts the projected point into the nearest grid point in the reference frame of the view corresponding to the intersection with the projection plane of the eye/view point vector and display the grid marker. Warning: When the grid is not active the result is identical to the above Convert() method. How to use: 1) Enable the grid echo display myViewer->SetGridEcho(Standard_True); 2) When application receive a move event: 2.1) Check if any object is detected if( myInteractiveContext->MoveTo(x,y) == AIS_SOD_Nothing ) { 2.2) Check if the grid is active if( myViewer->Grid()->IsActive() ) { 2.3) Display the grid echo and gets the grid point myView->ConvertToGrid(x,y,X,Y,Z); myView->Viewer()->ShowGridEcho (myView, Graphic3d_Vertex (X,Y,Z)); myView->RedrawImmediate(); 2.4) Else this is the standard case } else myView->Convert(x,y,X,Y,Z);. More...

void	ConvertToGrid (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, V3d_Coordinate &Xg, V3d_Coordinate &Yg, V3d_Coordinate &Zg) const
	Converts the point into the nearest grid point and display the grid marker. More...

void	Convert (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, Standard_Integer &Xp, Standard_Integer &Yp) const
	Projects the point defined in the reference frame of the view into the projected point in the associated window. More...

void	Project (const V3d_Coordinate X, const V3d_Coordinate Y, const V3d_Coordinate Z, V3d_Coordinate &Xp, V3d_Coordinate &Yp) const
	Converts the point defined in the user space of the view to the projected view plane point at z 0. More...

void	BackgroundColor (const Quantity_TypeOfColor Type, Quantity_Parameter &V1, Quantity_Parameter &V2, Quantity_Parameter &V3) const
	Returns the Background color values of the view depending of the color Type. More...

Quantity_Color	BackgroundColor () const
	Returns the Background color object of the view. More...

void	GradientBackgroundColors (Quantity_Color &Color1, Quantity_Color &Color2) const
	Returns the gradient background colour objects of the view. More...

Aspect_GradientBackground	GradientBackground () const
	Returns the gradient background of the view. More...

Quantity_Factor	Scale () const
	Returns the current value of the zoom expressed with respect to SetViewMappingDefault(). More...

void	AxialScale (Standard_Real &Sx, Standard_Real &Sy, Standard_Real &Sz) const
	Returns the current values of the anisotropic (axial) scale factors. More...

void	Size (Quantity_Length &Width, Quantity_Length &Height) const
	Returns the height and width of the view. More...

Standard_Real	ZSize () const
	Returns the Depth of the view . More...

void	Eye (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
	Returns the position of the eye. More...

void	FocalReferencePoint (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
	Returns the position of point which emanating the projections. More...

void	ProjReferenceAxe (const Standard_Integer Xpix, const Standard_Integer Ypix, V3d_Coordinate &XP, V3d_Coordinate &YP, V3d_Coordinate &ZP, V3d_Coordinate &VX, V3d_Coordinate &VY, V3d_Coordinate &VZ) const
	Returns the coordinate of the point (Xpix,Ypix) in the view (XP,YP,ZP), and the projection vector of the view passing by the point (for PerspectiveView). More...

Quantity_Length	Depth () const
	Returns the Distance between the Eye and View Point. More...

void	Proj (Quantity_Parameter &Vx, Quantity_Parameter &Vy, Quantity_Parameter &Vz) const
	Returns the projection vector. More...

void	At (V3d_Coordinate &X, V3d_Coordinate &Y, V3d_Coordinate &Z) const
	Returns the position of the view point. More...

void	Up (Quantity_Parameter &Vx, Quantity_Parameter &Vy, Quantity_Parameter &Vz) const
	Returns the vector giving the position of the high point. More...

Quantity_PlaneAngle	Twist () const
	Returns in RADIANS the orientation of the view around the visual axis measured from the Y axis of the screen. More...

V3d_TypeOfShadingModel	ShadingModel () const
	Returns the current shading model. More...

V3d_TypeOfSurfaceDetail	SurfaceDetail () const

Handle< Graphic3d_TextureEnv >	TextureEnv () const

V3d_TypeOfVisualization	Visualization () const
	Returns the current visualisation mode. More...

Standard_Boolean	Antialiasing () const
	Indicates if the antialiasing is active (True) or inactive (False). More...

Standard_Boolean	ZCueing (Quantity_Length &Depth, Quantity_Length &Width) const
	Returns activity and information on the Zcueing. <Depth> : Depth of plane. <Width> : Thickness around the plane. More...

V3d_TypeOfZclipping	ZClipping (Quantity_Length &Depth, Quantity_Length &Width) const
	Returns current information on the ZClipping. <Depth> : Depth of plane. <Width> : Thickness around the plane. <TypeOfZclipping> : "BACK" "FRONT" "SLICE" "OFF". More...

Standard_Boolean	IfMoreLights () const
	Returns True if One light more can be activated in this View. More...

void	InitActiveLights ()
	initializes an iteration on the active Lights. More...

Standard_Boolean	MoreActiveLights () const
	returns true if there are more active Light(s) to return. More...

void	NextActiveLights ()
	Go to the next active Light (if there is not, ActiveLight will raise an exception) More...

Handle< V3d_Light >	ActiveLight () const

Handle< V3d_Viewer >	Viewer () const
	Returns the viewer in which the view has been created. More...

Standard_Boolean	IfWindow () const
	Returns True if MyView is associated with a window . More...

Handle< Aspect_Window >	Window () const
	Returns the Aspect Window associated with the view. More...

V3d_TypeOfView	Type () const
	Returns the Type of the View. More...

void	Pan (const Standard_Integer theDXp, const Standard_Integer theDYp, const Quantity_Factor theZoomFactor=1, const Standard_Boolean theToStart=Standard_True)
	Translates the center of the view along "x" and "y" axes of view projection. Can be used to perform interactive panning operation. In that case the DXp, DXp parameters specify panning relative to the point where the operation is started. More...

void	Zoom (const Standard_Integer theXp1, const Standard_Integer theYp1, const Standard_Integer theXp2, const Standard_Integer theYp2)
	Zoom the view according to a zoom factor computed from the distance between the 2 mouse position. More...

void	StartZoomAtPoint (const Standard_Integer theXp, const Standard_Integer theYp)
	Defines starting point for ZoomAtPoint view operation. More...

void	ZoomAtPoint (const Standard_Integer theMouseStartX, const Standard_Integer theMouseStartY, const Standard_Integer theMouseEndX, const Standard_Integer theMouseEndY)
	Zooms the model at a pixel defined by the method StartZoomAtPoint(). More...

void	AxialScale (const Standard_Integer Dx, const Standard_Integer Dy, const V3d_TypeOfAxe Axis)
	Performs anisotropic scaling of <me> view along the given <Axis>. The scale factor is calculated on a basis of the mouse pointer displacement <Dx,Dy>. The calculated scale factor is then passed to SetAxialScale(Sx, Sy, Sz) method. More...

void	StartRotation (const Standard_Integer X, const Standard_Integer Y, const Quantity_Ratio zRotationThreshold=0.0)
	Begin the rotation of the view around the screen axis according to the mouse position <X,Y>. Warning: Enable rotation around the Z screen axis when <zRotationThreshold> factor is > 0 soon the distance from the start point and the center of the view is > (medium viewSize * <zRotationThreshold> ). Generally a value of 0.4 is usable to rotate around XY screen axis inside the circular threshold area and to rotate around Z screen axis outside this area. More...

void	Rotation (const Standard_Integer X, const Standard_Integer Y)
	Continues the rotation of the view with an angle computed from the last and new mouse position <X,Y>. More...

void	SetFocale (const Quantity_Length Focale)
	Change View Plane Distance for Perspective Views Warning! raises TypeMismatch from Standard if the view is not a perspective view. More...

Quantity_Length	Focale () const
	Returns the View Plane Distance for Perspective Views. More...

Handle< Visual3d_View >	View () const
	Returns the associated Visual3d view. More...

void	SetComputedMode (const Standard_Boolean aMode)
	Switches computed HLR mode in the view. More...

Standard_Boolean	ComputedMode () const
	Returns the computed HLR mode state. More...

void	WindowFitAll (const Standard_Integer Xmin, const Standard_Integer Ymin, const Standard_Integer Xmax, const Standard_Integer Ymax)
	idem than WindowFit More...

void	SetGrid (const gp_Ax3 &aPlane, const Handle< Aspect_Grid > &aGrid)
	Defines or Updates the definition of the grid in <me> More...

void	SetGridGraphicValues (const Handle< Aspect_Grid > &aGrid)
	Defines or Updates the graphic definition of the grid in <me> More...

void	SetGridActivity (const Standard_Boolean aFlag)
	Defines or Updates the activity of the grid in <me> More...

Standard_Boolean	Dump (const Standard_CString theFile, const Graphic3d_BufferType &theBufferType=Graphic3d_BT_RGB)
	dump the full contents of the view at the same scale in the file <theFile>. The file name extension must be one of ".png",".bmp",".jpg",".gif". Returns FALSE when the dump has failed More...

Standard_Boolean	Print (const Aspect_Handle hPrnDC=0, const Standard_Boolean showDialog=Standard_True, const Standard_Boolean showBackground=Standard_True, const Standard_CString filename=NULL, const Aspect_PrintAlgo printAlgorithm=Aspect_PA_STRETCH) const
	print the contents of the view to printer with preview. <hPrnDC> : If you have already an PrinterDeviceContext (HDC), then you can pass it to the print routines. If you don't have an PrinterDeviceContext, then this parameter should be NULL. <showDialog> : If hPrnDC == NULL, then you can force the print routines to open a Print Dialog box. If you want to do this, then set showDialog to TRUE If you don't want to see a dialog (only possible, if you have a hPrnDC or the dialog box was opened once before) then set <showDialog> to FALSE. <showBackground> : When set to FALSE then print the view without background color (background is white) else set to TRUE for printing with current background color. <filename>: If != NULL, then the view will be printed to a file. <printAlgorithm>: If you want to select the print algorithm, then you can specify one of existing algorithms: Aspect_PA_STRETCH, Aspect_PA_TILE. Returns Standard_True if the data is passed to the printer, otherwise Standard_False if the print operation failed. This might be related to insufficient memory or some internal errors. All this errors are indicated by the message boxes (on level of OpenGl_GraphicDriver). Warning: This function can reuse FBO assigned to the view on level of OpenGl_GraphicDriver; Please take it into account if you use it for your purposes; Warning: Works only under Windows. More...

Standard_Boolean	ToPixMap (Image_PixMap &theImage, const Standard_Integer theWidth, const Standard_Integer theHeight, const Graphic3d_BufferType &theBufferType=Graphic3d_BT_RGB, const Standard_Boolean theToKeepAspect=Standard_True, const V3d_StereoDumpOptions theStereoOptions=V3d_SDO_MONO)
	Dumps the full contents of the view to a pixmap of pixel size <theWidth> * <theHeight> and buffer type <theBufferType>. If <theToKeepAspect> is true the aspect ratio of view will be kept if <theWidth> and <theHeight> define another ratio. Pixmap will be automatically (re)allocated when needed. When dumping stereographic camera - the corresponding middle-point monographic projection will be used for dumping by default. <theStereoOptions> flags are to be used for dumping then left or right eye projections. More...

void	SetBackFacingModel (const V3d_TypeOfBackfacingModel aModel=V3d_TOBM_AUTOMATIC)
	Manages display of the back faces When <aModel> is TOBM_AUTOMATIC the object backfaces are displayed only for surface objects and never displayed for solid objects. this was the previous mode. <aModel> is TOBM_ALWAYS_DISPLAYED the object backfaces are always displayed both for surfaces or solids. <aModel> is TOBM_NEVER_DISPLAYED the object backfaces are never displayed. More...

V3d_TypeOfBackfacingModel	BackFacingModel () const
	Returns current state of the back faces display. More...

void	EnableDepthTest (const Standard_Boolean enable=Standard_True) const
	turns on/off opengl depth testing More...

Standard_Boolean	IsDepthTestEnabled () const
	returns the current state of the depth testing More...

void	EnableGLLight (const Standard_Boolean enable=Standard_True) const
	turns on/off opengl lighting, currently used in triedron displaying More...

Standard_Boolean	IsGLLightEnabled () const
	returns the current state of the gl lighting currently used in triedron displaying More...

virtual void	AddClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
	Adds clip plane to the view. The composition of clip planes truncates the rendering space to convex volume. Number of supported clip planes can be consulted by PlaneLimit method of associated Visual3d_View. Please be aware that the planes which exceed the limit are ignored during rendering. More...

virtual void	RemoveClipPlane (const Handle< Graphic3d_ClipPlane > &thePlane)
	Removes clip plane from the view. More...

void	SetClipPlanes (const Graphic3d_SequenceOfHClipPlane &thePlanes)
	Sets sequence of clip planes to the view. The planes that have been set before are removed from the view. The composition of clip planes truncates the rendering space to convex volume. Number of supported clip planes can be consulted by PlaneLimit method of associated Visual3d_View. Please be aware that the planes which exceed the limit are ignored during rendering. More...

const Graphic3d_SequenceOfHClipPlane &	GetClipPlanes () const
	Get clip planes. More...

void	SetCamera (const Handle< Graphic3d_Camera > &theCamera)
	Change camera used by view. More...

const Handle< Graphic3d_Camera > &	Camera () const
	Returns camera object of the view. More...

const Graphic3d_RenderingParams &	RenderingParams () const
	Returns current rendering parameters and effect settings. More...

Graphic3d_RenderingParams &	ChangeRenderingParams ()
	Returns reference to current rendering parameters and effect settings. More...

Standard_Boolean	IsCullingEnabled () const

void	SetFrustumCulling (const Standard_Boolean theMode)
	Turn on/off automatic culling of objects outside frustrum (ON by default) More...

Public Member Functions inherited from MMgt_TShared
virtual void	Delete () const
	Memory deallocator for transient classes. More...

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor. More...

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing. More...

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter. More...

virtual	~Standard_Transient ()
	Destructor must be virtual. More...

virtual const Handle_Standard_Type &	DynamicType () const
	Returns a type information object about this object. More...

Standard_Boolean	IsInstance (const Handle_Standard_Type &theType) const
	Returns a true value if this is an instance of Type. More...

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName. More...

Standard_Boolean	IsKind (const Handle_Standard_Type &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More...

virtual Handle_Standard_Transient	This () const
	Returns a Handle which references this object. Must never be called to objects created in stack. More...

Standard_Integer	GetRefCount () const
	Get the reference counter of this object. More...

Protected Member Functions
void	AddContext (NIS_InteractiveContext *)

void	RemoveContext (NIS_InteractiveContext *)

Protected Member Functions inherited from V3d_View
void	ImmediateUpdate () const

Standard_Boolean	FitMinMax (const Handle< Graphic3d_Camera > &theCamera, const Bnd_Box &theBox, const Standard_Real theMargin, const Standard_Real theResolution=0.0, const Standard_Boolean theToEnlargeIfLine=Standard_True) const
	Transform camera eye, center and scale to fit in the passed bounding box specified in WCS. More...

void	Scale (const Handle< Graphic3d_Camera > &theCamera, const Standard_Real theSizeXv, const Standard_Real theSizeYv) const
	Scales camera to fit the view frame of defined width and height keeping the aspect. For orthogonal camera the method changes scale, for perspective adjusts Eye location about the Center point. More...

void	Translate (const Handle< Graphic3d_Camera > &theCamera, const Standard_Real theDXv, const Standard_Real theDYv) const

Static Protected Member Functions
static int	MyCallback (Aspect_Drawable, void , Aspect_GraphicCallbackStruct )

Additional Inherited Members
Protected Attributes inherited from V3d_View
Standard_Real	myOldMouseX

Standard_Real	myOldMouseY

gp_Dir	myCamStartOpUp

gp_Pnt	myCamStartOpEye

Standard_Real	myCamStartOpBnd [6]

gp_Pnt	myCamStartOpCenter

Handle< Graphic3d_Camera >	myCamera

Handle< Visual3d_View >	MyView

Standard_Boolean	myImmediateUpdate

Detailed Description

Manager of a single window with OpenGL context, used by one or more NIS_InteractiveContext instances. This class inherits V3d_View 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:

AIS_InteractiveContext associated with the view by means of V3d_Viewer instance (the traditional AIS architecture);
1st associated NIS_InteractiveContext
2nd associated NIS_InteractiveContext
...

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

void NIS_View::AddContext ( NIS_InteractiveContext * )

protected

Register an interactive context for this view.

void NIS_View::DynamicHilight	(	const Standard_Integer	theX,
		const Standard_Integer	theY
	)

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.

void NIS_View::DynamicUnhilight ( )

inline

Unhilights the currently hilighted object.

Standard_Boolean NIS_View::FitAll3d ( const Quantity_Coefficient theCoef = 0.01 )

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

Parameters

theCoef Relative 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)

Bnd_B3f NIS_View::GetBndBox ( ) const

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

NCollection_Vector<NIS_InteractiveObject *> NIS_View::GetDetected ( ) const

inline

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

TColStd_PackedMapOfInteger& NIS_View::GetExListId ( )

inline

Obtain the IDs of ex-lists.

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

staticprotected

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

theX	X coordinate of mouse pointer in the window.
theY	Y 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

theAxis	3D axis for objects selection
theOver	Overlap for the selecting axis
isOnlySel	If 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.

void NIS_View::RemoveContext ( NIS_InteractiveContext * )

protected

Detach an interactive context from this view.

void NIS_View::Select	(	const Standard_Integer	theX,
		const Standard_Integer	theY,
		const Standard_Boolean	isForceMult = `Standard_False`,
		const Standard_Boolean	theRedraw = `Standard_True`
	)

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

Parameters

theX	X coordinate of the view window
theY	X coordinate of the view window
isForceMult	True if the effect of multi-Selection should be forced (e.g., when Shift is pressed).
theRedraw	True to redraw view automatically (default value).

void NIS_View::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`
	)

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

Parameters

theXmin	left X coordinate of the view window
theYmin	lower Y coordinate of the view window
theXmax	right X coordinate of the view window
theYmax	upper Y coordinate of the view window
isForceMult	True if the effect of multi-Selection should be forced (e.g., when Shift is pressed).
isFullyIncluded	True 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.
theRedraw	True to redraw view automatically (default value).

void NIS_View::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`
	)

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

Parameters

thePolygon	defines 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.
isForceMult	True if the effect of multi-Selection should be forced (e.g., when Shift is pressed).
isFullyIncluded	True 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.
theRedraw	True to redraw view automatically (default value).

void NIS_View::SetDynHilightSelected ( const Standard_Boolean theHilight = Standard_True )

inline

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

void NIS_View::SetHilightOnTop ( const Standard_Boolean theTop = Standard_True )

inline

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:

NIS_View.hxx

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation