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).
More...
|
| V3d_Viewer (const Handle< Graphic3d_GraphicDriver > &theDriver) |
| Create a Viewer with the given graphic driver and with default parameters: More...
|
|
Standard_Boolean | IfMoreViews () const |
| Returns True if One View more can be defined in this Viewer. More...
|
|
Handle< V3d_View > | CreateView () |
| Creates a view in the viewer according to its default parameters. More...
|
|
void | SetViewOn () |
| Activates all of the views of a viewer attached to a window. More...
|
|
void | SetViewOn (const Handle< V3d_View > &theView) |
| Activates a particular view in the Viewer. Must be call if the Window attached to the view has been Deiconified. More...
|
|
void | SetViewOff () |
| Deactivates all the views of a Viewer attached to a window. More...
|
|
void | SetViewOff (const Handle< V3d_View > &theView) |
| Deactivates a particular view in the Viewer. Must be call if the Window attached to the view has been Iconified . More...
|
|
void | Update () |
| Deprecated, Redraw() should be used instead. More...
|
|
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. More...
|
|
void | RedrawImmediate () const |
| Updates layer of immediate presentations. More...
|
|
void | Invalidate () const |
| Invalidates viewer content but does not redraw it. More...
|
|
void | Remove () |
| Suppresses the Viewer. More...
|
|
const Handle< Graphic3d_GraphicDriver > & | Driver () const |
| Return Graphic Driver instance. More...
|
|
Handle< Graphic3d_StructureManager > | StructureManager () const |
| Returns the structure manager associated to this viewer. More...
|
|
const Graphic3d_RenderingParams & | DefaultRenderingParams () const |
| Return default Rendering Parameters. By default these parameters are set in a new V3d_View. More...
|
|
void | SetDefaultRenderingParams (const Graphic3d_RenderingParams &theParams) |
| Set default Rendering Parameters. More...
|
|
void | SetDefaultBackgroundColor (const Quantity_Color &theColor) |
| Defines the default background colour of views attached to the viewer by supplying the color object. More...
|
|
const Aspect_GradientBackground & | GetGradientBackground () const |
| Returns the gradient background of the view. More...
|
|
void | SetDefaultBgGradientColors (const Quantity_Color &theColor1, const Quantity_Color &theColor2, const Aspect_GradientFillMethod theFillStyle=Aspect_GFM_HOR) |
| Defines the default gradient background colours of views attached to the viewer by supplying the colour objects. More...
|
|
Standard_Real | DefaultViewSize () const |
| Returns the default size of the view. More...
|
|
void | SetDefaultViewSize (const Standard_Real theSize) |
| Gives a default size for the creation of views of the viewer. More...
|
|
V3d_TypeOfOrientation | DefaultViewProj () const |
| Returns the default Projection. More...
|
|
void | SetDefaultViewProj (const V3d_TypeOfOrientation theOrientation) |
| Sets the default projection for creating views in the viewer. More...
|
|
V3d_TypeOfVisualization | DefaultVisualization () const |
| Returns the default type of Visualization. More...
|
|
void | SetDefaultVisualization (const V3d_TypeOfVisualization theType) |
| Gives the default visualization mode. More...
|
|
Graphic3d_TypeOfShadingModel | DefaultShadingModel () const |
| Returns the default type of Shading. More...
|
|
void | SetDefaultShadingModel (const Graphic3d_TypeOfShadingModel theType) |
| Gives the default type of SHADING. More...
|
|
V3d_TypeOfView | DefaultTypeOfView () const |
| Returns the default type of View (orthographic or perspective projection) to be returned by CreateView() method. More...
|
|
void | SetDefaultTypeOfView (const V3d_TypeOfView theType) |
| Set the default type of View (orthographic or perspective projection) to be returned by CreateView() method. More...
|
|
Quantity_Color | DefaultBackgroundColor () const |
| Returns the default background colour object. More...
|
|
void | DefaultBgGradientColors (Quantity_Color &theColor1, Quantity_Color &theColor2) const |
| Returns the gradient background colour objects of the view. More...
|
|
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. More...
|
|
Standard_Boolean | AddZLayer (Graphic3d_ZLayerId &theLayerId, const Graphic3d_ZLayerSettings &theSettings=Graphic3d_ZLayerSettings()) |
| 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. Custom layers will be inserted before Graphic3d_ZLayerId_Top (e.g. between Graphic3d_ZLayerId_Default and before Graphic3d_ZLayerId_Top). More...
|
|
Standard_Boolean | InsertLayerBefore (Graphic3d_ZLayerId &theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerAfter) |
| 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. Layer rendering order is defined by its position in list (altered by theLayerAfter) and IsImmediate() flag (all layers with IsImmediate() flag are drawn afterwards);. More...
|
|
Standard_Boolean | InsertLayerAfter (Graphic3d_ZLayerId &theNewLayerId, const Graphic3d_ZLayerSettings &theSettings, const Graphic3d_ZLayerId theLayerBefore) |
| 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. Layer rendering order is defined by its position in list (altered by theLayerAfter) and IsImmediate() flag (all layers with IsImmediate() flag are drawn afterwards);. More...
|
|
Standard_Boolean | RemoveZLayer (const Graphic3d_ZLayerId 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. More...
|
|
const Graphic3d_ZLayerSettings & | ZLayerSettings (const Graphic3d_ZLayerId theLayerId) const |
| Returns the settings of a single Z layer. More...
|
|
void | SetZLayerSettings (const Graphic3d_ZLayerId theLayerId, const Graphic3d_ZLayerSettings &theSettings) |
| Sets the settings for a single Z layer. More...
|
|
V3d_ListOfViewIterator | ActiveViewIterator () const |
| Return an iterator for active views. More...
|
|
void | InitActiveViews () |
| Initializes an internal iterator on the active views. More...
|
|
Standard_Boolean | MoreActiveViews () const |
| Returns true if there are more active view(s) to return. More...
|
|
void | NextActiveViews () |
| Go to the next active view (if there is not, ActiveView will raise an exception) More...
|
|
const Handle< V3d_View > & | ActiveView () const |
|
Standard_Boolean | LastActiveView () const |
| returns true if there is only one active view. More...
|
|
V3d_ListOfViewIterator | DefinedViewIterator () const |
| Return an iterator for defined views. More...
|
|
void | InitDefinedViews () |
| Initializes an internal iterator on the Defined views. More...
|
|
Standard_Boolean | MoreDefinedViews () const |
| returns true if there are more Defined view(s) to return. More...
|
|
void | NextDefinedViews () |
| Go to the next Defined view (if there is not, DefinedView will raise an exception) More...
|
|
const Handle< V3d_View > & | DefinedView () const |
|
|
void | SetDefaultLights () |
| Defines default lights: positional-light 0.3 0. 0. directional-light V3d_XnegYposZpos directional-light V3d_XnegYneg ambient-light. More...
|
|
void | SetLightOn (const Handle< V3d_Light > &theLight) |
| Activates MyLight in the viewer. More...
|
|
void | SetLightOn () |
| Activates all the lights defined in this viewer. More...
|
|
void | SetLightOff (const Handle< V3d_Light > &theLight) |
| Deactivates MyLight in this viewer. More...
|
|
void | SetLightOff () |
| Deactivate all the Lights defined in this viewer. More...
|
|
void | AddLight (const Handle< V3d_Light > &theLight) |
| Adds Light in Sequence Of Lights. More...
|
|
void | DelLight (const Handle< V3d_Light > &theLight) |
| Delete Light in Sequence Of Lights. More...
|
|
void | UpdateLights () |
| Updates the lights of all the views of a viewer. More...
|
|
Standard_Boolean | IsGlobalLight (const Handle< V3d_Light > &TheLight) const |
| Defines default lights: positional-light 0.3 0. 0. directional-light V3d_XnegYposZpos directional-light V3d_XnegYneg ambient-light. More...
|
|
V3d_ListOfLightIterator | ActiveLightIterator () const |
| Return an iterator for defined lights. More...
|
|
void | InitActiveLights () |
| Initializes an internal iteratator 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...
|
|
const Handle< V3d_Light > & | ActiveLight () const |
| Defines default lights: positional-light 0.3 0. 0. directional-light V3d_XnegYposZpos directional-light V3d_XnegYneg ambient-light. More...
|
|
V3d_ListOfLightIterator | DefinedLightIterator () const |
| Return an iterator for defined lights. More...
|
|
void | InitDefinedLights () |
| Initializes an internal iterattor on the Defined Lights. More...
|
|
Standard_Boolean | MoreDefinedLights () const |
| Returns true if there are more Defined Light(s) to return. More...
|
|
void | NextDefinedLights () |
| Go to the next Defined Light (if there is not, DefinedLight() will raise an exception) More...
|
|
const Handle< V3d_Light > & | DefinedLight () const |
| Defines default lights: positional-light 0.3 0. 0. directional-light V3d_XnegYposZpos directional-light V3d_XnegYneg ambient-light. More...
|
|
|
void | Erase () const |
| Erase all Objects in All the views. More...
|
|
void | UnHighlight () const |
| UnHighlight all Objects in All the views. More...
|
|
Standard_Boolean | ComputedMode () const |
| returns true if the computed mode can be used. More...
|
|
void | SetComputedMode (const Standard_Boolean theMode) |
| Set if the computed mode can be used. More...
|
|
Standard_Boolean | DefaultComputedMode () const |
| returns true if by default the computed mode must be used. More...
|
|
void | SetDefaultComputedMode (const Standard_Boolean theMode) |
| Set if by default the computed mode must be used. More...
|
|
|
const gp_Ax3 & | PrivilegedPlane () const |
|
void | SetPrivilegedPlane (const gp_Ax3 &thePlane) |
|
void | DisplayPrivilegedPlane (const Standard_Boolean theOnOff, const Standard_Real theSize=1) |
|
|
void | ActivateGrid (const Aspect_GridType aGridType, const Aspect_GridDrawMode aGridDrawMode) |
| Activates the grid in all views of <me>. More...
|
|
void | DeactivateGrid () |
| Deactivates the grid in all views of <me>. More...
|
|
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. More...
|
|
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. More...
|
|
Standard_Boolean | GridEcho () const |
| Returns TRUE when grid echo must be displayed at hit point. More...
|
|
Standard_Boolean | IsActive () const |
| Returns Standard_True if a grid is activated in <me>. More...
|
|
Handle< Aspect_Grid > | Grid () const |
| Returns the defined grid in <me>. More...
|
|
Aspect_GridType | GridType () const |
| Returns the current grid type defined in <me>. More...
|
|
Aspect_GridDrawMode | GridDrawMode () const |
| Returns the current grid draw mode defined in <me>. More...
|
|
void | RectangularGridValues (Standard_Real &XOrigin, Standard_Real &YOrigin, Standard_Real &XStep, Standard_Real &YStep, Standard_Real &RotationAngle) const |
| Returns the definition of the rectangular grid. More...
|
|
void | SetRectangularGridValues (const Standard_Real XOrigin, const Standard_Real YOrigin, const Standard_Real XStep, const Standard_Real YStep, const Standard_Real 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. More...
|
|
void | CircularGridValues (Standard_Real &XOrigin, Standard_Real &YOrigin, Standard_Real &RadiusStep, Standard_Integer &DivisionNumber, Standard_Real &RotationAngle) const |
| Returns the definition of the circular grid. More...
|
|
void | SetCircularGridValues (const Standard_Real XOrigin, const Standard_Real YOrigin, const Standard_Real RadiusStep, const Standard_Integer DivisionNumber, const Standard_Real 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. More...
|
|
void | CircularGridGraphicValues (Standard_Real &Radius, Standard_Real &OffSet) const |
| Returns the location and the size of the grid. More...
|
|
void | SetCircularGridGraphicValues (const Standard_Real Radius, const Standard_Real 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. More...
|
|
void | RectangularGridGraphicValues (Standard_Real &XSize, Standard_Real &YSize, Standard_Real &OffSet) const |
| Returns the location and the size of the grid. More...
|
|
void | SetRectangularGridGraphicValues (const Standard_Real XSize, const Standard_Real YSize, const Standard_Real 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. More...
|
|
void | ShowGridEcho (const Handle< V3d_View > &theView, const Graphic3d_Vertex &thePoint) |
| Display grid echo at requested point in the view. More...
|
|
void | HideGridEcho (const Handle< V3d_View > &theView) |
| Temporarly hide grid echo. 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 void | Delete () const |
| Memory deallocator for transient classes. More...
|
|
virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More...
|
|
Standard_Boolean | IsInstance (const opencascade::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 opencascade::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...
|
|
Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More...
|
|
Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More...
|
|
void | IncrementRefCounter () const |
| Increments the reference counter of this object. More...
|
|
Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More...
|
|