Open CASCADE Technology
6.5.4
|
Defines services on Viewer type objects.
The methods of this class allow editing and
interrogation of the parameters linked to the viewer
its friend classes (View,light,plane).
#include <V3d_Viewer.hxx>
Public Member Functions | |
V3d_Viewer (const Handle< Aspect_GraphicDevice > &Device, const Standard_ExtString aName, const Standard_CString aDomain="", const Quantity_Length ViewSize=1000.0, const V3d_TypeOfOrientation ViewProj=V3d_XposYnegZpos, const Quantity_NameOfColor ViewBackground=Quantity_NOC_GRAY30, const V3d_TypeOfVisualization Visualization=V3d_ZBUFFER, const V3d_TypeOfShadingModel ShadingModel=V3d_GOURAUD, const V3d_TypeOfUpdate UpdateMode=V3d_WAIT, const Standard_Boolean ComputedMode=Standard_True, const Standard_Boolean DefaultComputedMode=Standard_True, const V3d_TypeOfSurfaceDetail SurfaceDetail=V3d_TEX_NONE) | |
Create a Viewer on the given device with the given parameters or with their default values. //! If the size of the view is <= 0 if ComputedMode is false, only the degenerate mode will be used. Warning: Client must creates a graphic-device of type Graphic3d_GraphicDevice under UNIX or Graphic3d_WNTGraphicDevice under WindowsNT | |
Handle_V3d_View | CreateView () |
creates a view in the viewer according to its default parameters. | |
Handle_V3d_OrthographicView | DefaultOrthographicView () |
Handle_V3d_PerspectiveView | DefaultPerspectiveView () |
void | SetViewOn () |
Activates all of the views of a viewer attached to a window. | |
void | SetViewOn (const Handle< V3d_View > &View) |
Activates a particular view in the Viewer . Must be call if the Window attached to the view has been Deiconified . | |
void | SetViewOff () |
Deactivates all the views of a Viewer attached to a window. | |
void | SetViewOff (const Handle< V3d_View > &View) |
Deactivates a particular view in the Viewer. Must be call if the Window attached to the view has been Iconified . | |
void | Update () |
Deprecated, Redraw() should be used instead. | |
void | UpdateLights () |
Updates the lights of all the views of a viewer. | |
void | Redraw () const |
Redraws all the views of the Viewer even if no modification has taken place. Must be called if all the views of the Viewer are exposed, as for example in a global DeIconification. | |
void | Remove () |
Suppresses the Viewer. | |
void | Erase () const |
Erase all Objects in All the views. | |
void | UnHighlight () const |
UnHighlight all Objects in All the views. | |
void | SetDefaultBackgroundColor (const Quantity_TypeOfColor Type, const Quantity_Parameter V1, const Quantity_Parameter V2, const Quantity_Parameter V3) |
Defines the default base colour of views attached to the Viewer by supplying the type of colour definition and the three component values.. | |
void | SetDefaultBackgroundColor (const Quantity_NameOfColor Name) |
Defines the default background colour of views attached to the viewer by supplying the name of the colour under the form Quantity_NOC_xxxx . | |
void | SetDefaultBackgroundColor (const Quantity_Color &Color) |
Defines the default background colour of views attached to the viewer by supplying the color object | |
void | SetDefaultBgGradientColors (const Quantity_NameOfColor Name1, const Quantity_NameOfColor Name2, const Aspect_GradientFillMethod FillStyle=Aspect_GFM_HOR) |
Defines the default gradient background colours of view attached to the viewer by supplying the name of the colours under the form Quantity_NOC_xxxx . | |
void | SetDefaultBgGradientColors (const Quantity_Color &Color1, const Quantity_Color &Color2, const Aspect_GradientFillMethod FillStyle=Aspect_GFM_HOR) |
Defines the default gradient background colours of views attached to the viewer by supplying the colour objects | |
void | SetDefaultViewSize (const Quantity_Length Size) |
Gives a default size for the creation of views of the viewer. | |
void | SetDefaultViewProj (const V3d_TypeOfOrientation Orientation) |
Gives the default projection for creating views in the viewer. | |
void | SetDefaultVisualization (const V3d_TypeOfVisualization Type) |
Gives the default visualisation mode.. | |
void | SetZBufferManagment (const Standard_Boolean Automatic) |
defines the strategy concerning the ZBuffer activity. If Automatic is true, ZBuffer will be activated or deactivated depending on the fact that faces exist or not in the Viewer. This will optimize the response time in the case where only wireframe objects are displayed. If Automatic is False, ZBuffer will be activated or deactivated depending on the choice of SetVisualization in each View. Note that by default, the ZBufferManagment is not automatic. | |
Standard_Boolean | ZBufferManagment () const |
returns the ZBuffer stategy choice. | |
void | SetDefaultShadingModel (const V3d_TypeOfShadingModel Type) |
Gives the default type of SHADING. | |
void | SetDefaultSurfaceDetail (const V3d_TypeOfSurfaceDetail Type) |
Gives the default type of texture mapping. | |
void | SetDefaultAngle (const Quantity_PlaneAngle Angle) |
void | SetUpdateMode (const V3d_TypeOfUpdate Mode) |
Defines the mode of regenerating the views making up the viewer. This can be immediate <ASAP> or deferred <WAIT>. In this latter case, the views are updated when the method Update(me) is called. | |
void | SetDefaultTypeOfView (const V3d_TypeOfView Type) |
void | SetPrivilegedPlane (const gp_Ax3 &aPlane) |
gp_Ax3 | PrivilegedPlane () const |
void | DisplayPrivilegedPlane (const Standard_Boolean OnOff, const Quantity_Length aSize=1) |
void | SetLightOn (const Handle< V3d_Light > &MyLight) |
Activates MyLight in the viewer. | |
void | SetLightOn () |
Activates all the lights defined in this viewer. | |
void | SetLightOff (const Handle< V3d_Light > &MyLight) |
Desactivate MyLight in this viewer. | |
void | SetLightOff () |
Deactivate all the Lights defined in this viewer. | |
void | DelLight (const Handle< V3d_Light > &MyLight) |
Delete Light in Sequence Of Lights. | |
void | SetCurrentSelectedLight (const Handle< V3d_Light > &TheLight) |
Defines the selected light. | |
void | ClearCurrentSelectedLight () |
Defines the selected light at NULL. | |
void | DefaultBackgroundColor (const Quantity_TypeOfColor Type, Quantity_Parameter &V1, Quantity_Parameter &V2, Quantity_Parameter &V3) const |
Returns the default background colour depending of the type. | |
Quantity_Color | DefaultBackgroundColor () const |
Returns the default background colour object. | |
void | DefaultBgGradientColors (Quantity_Color &Color1, Quantity_Color &Color2) const |
Returns the gradient background colour objects of the view. | |
Quantity_Length | DefaultViewSize () const |
Returns the default size of the view. | |
V3d_TypeOfOrientation | DefaultViewProj () const |
Returns the default Projection. | |
V3d_TypeOfVisualization | DefaultVisualization () const |
Returns the default type of Visualization. | |
V3d_TypeOfShadingModel | DefaultShadingModel () const |
Returns the default type of Shading | |
V3d_TypeOfSurfaceDetail | DefaultSurfaceDetail () const |
Returns the default type of texture mapping | |
Quantity_PlaneAngle | DefaultAngle () const |
V3d_TypeOfUpdate | UpdateMode () const |
Returns the regeneration mode of views in the viewer. | |
Standard_Boolean | IfMoreViews () const |
Returns True if One View more can be activated in this Viewer. | |
void | InitActiveViews () |
initializes an iteration on the active views. | |
Standard_Boolean | MoreActiveViews () const |
returns true if there are more active view(s) to return. | |
void | NextActiveViews () |
Go to the next active view (if there is not, ActiveView will raise an exception) | |
Handle_V3d_View | ActiveView () const |
Standard_Boolean | LastActiveView () const |
returns true if there is only one active view. | |
void | InitDefinedViews () |
initializes an iteration on the Defined views. | |
Standard_Boolean | MoreDefinedViews () const |
returns true if there are more Defined view(s) to return. | |
void | NextDefinedViews () |
Go to the next Defined view (if there is not, DefinedView will raise an exception) | |
Handle_V3d_View | DefinedView () const |
void | InitActiveLights () |
initializes an iteration on the active Lights. | |
Standard_Boolean | MoreActiveLights () const |
returns true if there are more active Light(s) to return. | |
void | NextActiveLights () |
Go to the next active Light (if there is not, ActiveLight will raise an exception) | |
Handle_V3d_Light | ActiveLight () const |
void | InitDefinedLights () |
initializes an iteration on the Defined Lights. | |
Standard_Boolean | MoreDefinedLights () const |
returns true if there are more Defined Light(s) to return. | |
void | NextDefinedLights () |
Go to the next Defined Light (if there is not, DefinedLight will raise an exception) | |
Handle_V3d_Light | DefinedLight () const |
void | AddPlane (const Handle< V3d_Plane > &MyPlane) |
Adds Plane in Sequence Of Planes. | |
void | DelPlane (const Handle< V3d_Plane > &MyPlane) |
Delete Plane in Sequence Of Planes. | |
void | InitDefinedPlanes () |
initializes an iteration on the Defined Planes. | |
Standard_Boolean | MoreDefinedPlanes () const |
returns true if there are more Defined Plane(s) to return. | |
void | NextDefinedPlanes () |
Go to the next Defined Plane (if there is not, DefinedPlane will raise an exception) | |
Handle_V3d_Plane | DefinedPlane () const |
Handle_Visual3d_ViewManager | Viewer () const |
Returns the viewer associated to Visual3d . | |
Handle_V3d_Light | CurrentSelectedLight () const |
Returns the Selected Light. | |
Standard_Boolean | IsGlobalLight (const Handle< V3d_Light > &TheLight) const |
Standard_Boolean | ComputedMode () const |
returns true if the computed mode can be used. | |
Standard_Boolean | DefaultComputedMode () const |
returns true if by default the computed mode must be used. | |
void | ActivateGrid (const Aspect_GridType aGridType, const Aspect_GridDrawMode aGridDrawMode) |
Activates the grid in all views of <me>. | |
void | DeactivateGrid () |
Deactivates the grid in all views of <me>. | |
void | SetGridEcho (const Standard_Boolean showGrid=Standard_True) |
Show/Don't show grid echo to the hit point. If TRUE,the grid echo will be shown at ConvertToGrid() time. | |
void | SetGridEcho (const Handle< Graphic3d_AspectMarker3d > &aMarker) |
Show grid echo <aMarker> to the hit point. Warning: When the grid echo marker is not set, a default marker is build with the attributes: marker type : Aspect_TOM_STAR marker color : Quantity_NOC_GRAY90 marker size : 3.0 | |
Standard_Boolean | GridEcho () const |
Returns TRUE when grid echo must be displayed at hit point. | |
Standard_Boolean | IsActive () const |
Returns Standard_True if a grid is activated in <me>. | |
Handle_Aspect_Grid | Grid () const |
Returns the defined grid in <me>. | |
Aspect_GridType | GridType () const |
Returns the current grid type defined in <me>. | |
Aspect_GridDrawMode | GridDrawMode () const |
Returns the current grid draw mode defined in <me>. | |
void | RectangularGridValues (Quantity_Length &XOrigin, Quantity_Length &YOrigin, Quantity_Length &XStep, Quantity_Length &YStep, Quantity_PlaneAngle &RotationAngle) const |
Returns the definition of the rectangular grid. | |
void | SetRectangularGridValues (const Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length XStep, const Quantity_Length YStep, const Quantity_PlaneAngle RotationAngle) |
Sets the definition of the rectangular grid. <XOrigin>, <YOrigin> defines the origin of the grid. <XStep> defines the interval between 2 vertical lines. <YStep> defines the interval between 2 horizontal lines. <RotationAngle> defines the rotation angle of the grid. | |
void | CircularGridValues (Quantity_Length &XOrigin, Quantity_Length &YOrigin, Quantity_Length &RadiusStep, Standard_Integer &DivisionNumber, Quantity_PlaneAngle &RotationAngle) const |
Returns the definition of the circular grid. | |
void | SetCircularGridValues (const Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length RadiusStep, const Standard_Integer DivisionNumber, const Quantity_PlaneAngle RotationAngle) |
Sets the definition of the circular grid. <XOrigin>, <YOrigin> defines the origin of the grid. <RadiusStep> defines the interval between 2 circles. <DivisionNumber> defines the section number of one half circle. <RotationAngle> defines the rotation angle of the grid. | |
void | CircularGridGraphicValues (Quantity_Length &Radius, Quantity_Length &OffSet) const |
Returns the location and the size of the grid. | |
void | SetCircularGridGraphicValues (const Quantity_Length Radius, const Quantity_Length OffSet) |
Sets the location and the size of the grid. <XSize> defines the width of the grid. <YSize> defines the height of the grid. <OffSet> defines the displacement along the plane normal. | |
void | RectangularGridGraphicValues (Quantity_Length &XSize, Quantity_Length &YSize, Quantity_Length &OffSet) const |
Returns the location and the size of the grid. | |
void | SetRectangularGridGraphicValues (const Quantity_Length XSize, const Quantity_Length YSize, const Quantity_Length OffSet) |
Sets the location and the size of the grid. <XSize> defines the width of the grid. <YSize> defines the height of the grid. <OffSet> defines the displacement along the plane normal. | |
Aspect_GradientBackground | GetGradientBackground () const |
Returns the gradient background of the view. | |
void | SetDefaultLights () |
defines default lights - positional-light 0.3 0. 0. directional-light V3d_XnegYposZpos directional-light V3d_XnegYneg ambient-light | |
void | Init () |
Standard_Boolean | AddZLayer (Standard_Integer &theLayerId) |
Add a new top-level Z layer to all managed views and get its ID as <theLayerId> value. The Z layers are controlled entirely by viewer, it is not possible to add a layer to a particular view. The method returns Standard_False if the layer can not be created. The layer mechanism allows to display structures in higher layers in overlay of structures in lower layers. | |
Standard_Boolean | RemoveZLayer (const Standard_Integer theLayerId) |
Remove Z layer with ID <theLayerId>. Method returns Standard_False if the layer can not be removed or doesn't exists. By default, there are always default bottom-level layer that can't be removed. | |
void | GetAllZLayers (TColStd_SequenceOfInteger &theLayerSeq) const |
Return all Z layer ids in sequence ordered by overlay level from lowest layer to highest ( foreground ). The first layer ID in sequence is the default layer that can't be removed. | |
Friends | |
void | V3d::SetPlane (const Handle< V3d_Viewer > &aViewer, const Quantity_Length x1, const Quantity_Length y1, const Quantity_Length z1, const Quantity_Length x2, const Quantity_Length y2, const Quantity_Length z2) |
test. |
V3d_Viewer::V3d_Viewer | ( | const Handle< Aspect_GraphicDevice > & | Device, |
const Standard_ExtString | aName, | ||
const Standard_CString | aDomain = "" , |
||
const Quantity_Length | ViewSize = 1000.0 , |
||
const V3d_TypeOfOrientation | ViewProj = V3d_XposYnegZpos , |
||
const Quantity_NameOfColor | ViewBackground = Quantity_NOC_GRAY30 , |
||
const V3d_TypeOfVisualization | Visualization = V3d_ZBUFFER , |
||
const V3d_TypeOfShadingModel | ShadingModel = V3d_GOURAUD , |
||
const V3d_TypeOfUpdate | UpdateMode = V3d_WAIT , |
||
const Standard_Boolean | ComputedMode = Standard_True , |
||
const Standard_Boolean | DefaultComputedMode = Standard_True , |
||
const V3d_TypeOfSurfaceDetail | SurfaceDetail = V3d_TEX_NONE |
||
) |
void V3d_Viewer::ActivateGrid | ( | const Aspect_GridType | aGridType, |
const Aspect_GridDrawMode | aGridDrawMode | ||
) |
Handle_V3d_Light V3d_Viewer::ActiveLight | ( | ) | const |
Handle_V3d_View V3d_Viewer::ActiveView | ( | ) | const |
void V3d_Viewer::AddPlane | ( | const Handle< V3d_Plane > & | MyPlane | ) |
Standard_Boolean V3d_Viewer::AddZLayer | ( | Standard_Integer & | theLayerId | ) |
void V3d_Viewer::CircularGridGraphicValues | ( | Quantity_Length & | Radius, |
Quantity_Length & | OffSet | ||
) | const |
void V3d_Viewer::CircularGridValues | ( | Quantity_Length & | XOrigin, |
Quantity_Length & | YOrigin, | ||
Quantity_Length & | RadiusStep, | ||
Standard_Integer & | DivisionNumber, | ||
Quantity_PlaneAngle & | RotationAngle | ||
) | const |
Standard_Boolean V3d_Viewer::ComputedMode | ( | ) | const |
Handle_V3d_View V3d_Viewer::CreateView | ( | ) |
Handle_V3d_Light V3d_Viewer::CurrentSelectedLight | ( | ) | const |
Quantity_PlaneAngle V3d_Viewer::DefaultAngle | ( | ) | const |
void V3d_Viewer::DefaultBackgroundColor | ( | const Quantity_TypeOfColor | Type, |
Quantity_Parameter & | V1, | ||
Quantity_Parameter & | V2, | ||
Quantity_Parameter & | V3 | ||
) | const |
void V3d_Viewer::DefaultBgGradientColors | ( | Quantity_Color & | Color1, |
Quantity_Color & | Color2 | ||
) | const |
Handle_V3d_OrthographicView V3d_Viewer::DefaultOrthographicView | ( | ) |
Handle_V3d_PerspectiveView V3d_Viewer::DefaultPerspectiveView | ( | ) |
Quantity_Length V3d_Viewer::DefaultViewSize | ( | ) | const |
Handle_V3d_Light V3d_Viewer::DefinedLight | ( | ) | const |
Handle_V3d_Plane V3d_Viewer::DefinedPlane | ( | ) | const |
Handle_V3d_View V3d_Viewer::DefinedView | ( | ) | const |
void V3d_Viewer::DelLight | ( | const Handle< V3d_Light > & | MyLight | ) |
void V3d_Viewer::DelPlane | ( | const Handle< V3d_Plane > & | MyPlane | ) |
void V3d_Viewer::DisplayPrivilegedPlane | ( | const Standard_Boolean | OnOff, |
const Quantity_Length | aSize = 1 |
||
) |
void V3d_Viewer::Erase | ( | ) | const |
void V3d_Viewer::GetAllZLayers | ( | TColStd_SequenceOfInteger & | theLayerSeq | ) | const |
Handle_Aspect_Grid V3d_Viewer::Grid | ( | ) | const |
Aspect_GridDrawMode V3d_Viewer::GridDrawMode | ( | ) | const |
Standard_Boolean V3d_Viewer::GridEcho | ( | ) | const |
Aspect_GridType V3d_Viewer::GridType | ( | ) | const |
Standard_Boolean V3d_Viewer::IfMoreViews | ( | ) | const |
void V3d_Viewer::Init | ( | ) |
Standard_Boolean V3d_Viewer::IsActive | ( | ) | const |
Standard_Boolean V3d_Viewer::IsGlobalLight | ( | const Handle< V3d_Light > & | TheLight | ) | const |
Standard_Boolean V3d_Viewer::LastActiveView | ( | ) | const |
Standard_Boolean V3d_Viewer::MoreActiveLights | ( | ) | const |
Standard_Boolean V3d_Viewer::MoreActiveViews | ( | ) | const |
Standard_Boolean V3d_Viewer::MoreDefinedViews | ( | ) | const |
gp_Ax3 V3d_Viewer::PrivilegedPlane | ( | ) | const |
void V3d_Viewer::RectangularGridGraphicValues | ( | Quantity_Length & | XSize, |
Quantity_Length & | YSize, | ||
Quantity_Length & | OffSet | ||
) | const |
void V3d_Viewer::RectangularGridValues | ( | Quantity_Length & | XOrigin, |
Quantity_Length & | YOrigin, | ||
Quantity_Length & | XStep, | ||
Quantity_Length & | YStep, | ||
Quantity_PlaneAngle & | RotationAngle | ||
) | const |
void V3d_Viewer::Redraw | ( | ) | const |
Standard_Boolean V3d_Viewer::RemoveZLayer | ( | const Standard_Integer | theLayerId | ) |
void V3d_Viewer::SetCircularGridGraphicValues | ( | const Quantity_Length | Radius, |
const Quantity_Length | OffSet | ||
) |
void V3d_Viewer::SetCircularGridValues | ( | const Quantity_Length | XOrigin, |
const Quantity_Length | YOrigin, | ||
const Quantity_Length | RadiusStep, | ||
const Standard_Integer | DivisionNumber, | ||
const Quantity_PlaneAngle | RotationAngle | ||
) |
void V3d_Viewer::SetCurrentSelectedLight | ( | const Handle< V3d_Light > & | TheLight | ) |
void V3d_Viewer::SetDefaultBackgroundColor | ( | const Quantity_TypeOfColor | Type, |
const Quantity_Parameter | V1, | ||
const Quantity_Parameter | V2, | ||
const Quantity_Parameter | V3 | ||
) |
void V3d_Viewer::SetDefaultBgGradientColors | ( | const Quantity_NameOfColor | Name1, |
const Quantity_NameOfColor | Name2, | ||
const Aspect_GradientFillMethod | FillStyle = Aspect_GFM_HOR |
||
) |
void V3d_Viewer::SetDefaultBgGradientColors | ( | const Quantity_Color & | Color1, |
const Quantity_Color & | Color2, | ||
const Aspect_GradientFillMethod | FillStyle = Aspect_GFM_HOR |
||
) |
void V3d_Viewer::SetDefaultViewProj | ( | const V3d_TypeOfOrientation | Orientation | ) |
void V3d_Viewer::SetGridEcho | ( | const Standard_Boolean | showGrid = Standard_True | ) |
void V3d_Viewer::SetGridEcho | ( | const Handle< Graphic3d_AspectMarker3d > & | aMarker | ) |
void V3d_Viewer::SetLightOff | ( | const Handle< V3d_Light > & | MyLight | ) |
void V3d_Viewer::SetLightOn | ( | const Handle< V3d_Light > & | MyLight | ) |
void V3d_Viewer::SetPrivilegedPlane | ( | const gp_Ax3 & | aPlane | ) |
void V3d_Viewer::SetRectangularGridGraphicValues | ( | const Quantity_Length | XSize, |
const Quantity_Length | YSize, | ||
const Quantity_Length | OffSet | ||
) |
void V3d_Viewer::SetRectangularGridValues | ( | const Quantity_Length | XOrigin, |
const Quantity_Length | YOrigin, | ||
const Quantity_Length | XStep, | ||
const Quantity_Length | YStep, | ||
const Quantity_PlaneAngle | RotationAngle | ||
) |
void V3d_Viewer::SetViewOff | ( | const Handle< V3d_View > & | View | ) |
void V3d_Viewer::SetViewOn | ( | const Handle< V3d_View > & | View | ) |
void V3d_Viewer::SetZBufferManagment | ( | const Standard_Boolean | Automatic | ) |
void V3d_Viewer::UnHighlight | ( | ) | const |
void V3d_Viewer::Update | ( | ) | [virtual] |
Implements Viewer_Viewer.
V3d_TypeOfUpdate V3d_Viewer::UpdateMode | ( | ) | const |
Handle_Visual3d_ViewManager V3d_Viewer::Viewer | ( | ) | const |
Standard_Boolean V3d_Viewer::ZBufferManagment | ( | ) | const |
void V3d::SetPlane | ( | const Handle< V3d_Viewer > & | aViewer, |
const Quantity_Length | x1, | ||
const Quantity_Length | y1, | ||
const Quantity_Length | z1, | ||
const Quantity_Length | x2, | ||
const Quantity_Length | y2, | ||
const Quantity_Length | z2 | ||
) | [friend] |