Logo Search packages:      
Sourcecode: opencascade version File versions  Download package

V3d_Viewer Class Reference

#include <V3d_Viewer.hxx>

Inheritance diagram for V3d_Viewer:

MMgt_TShared Standard_Transient

List of all members.


Detailed Description

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).

Definition at line 171 of file V3d_Viewer.hxx.


Public Member Functions

Standard_EXPORT void ActivateGrid (const Aspect_GridType aGridType, const Aspect_GridDrawMode aGridDrawMode)
 Activates the grid in all views of <me>.
.
Standard_EXPORT Handle_V3d_Light ActiveLight () const
Standard_EXPORT Handle_V3d_View ActiveView () const
Standard_EXPORT void CircularGridGraphicValues (Quantity_Length &Radius, Quantity_Length &OffSet) const
 Returns the location and the size of the grid.
.
Standard_EXPORT 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.
.
Standard_EXPORT void ClearCurrentSelectedLight ()
 Defines the selected light at NULL.
.
Standard_EXPORT Standard_Boolean ComputedMode () const
 returns true if the computed mode can be used.

Standard_EXPORT Handle_V3d_View CreateView ()
Standard_EXPORT Handle_V3d_Light CurrentSelectedLight () const
 Returns the Selected Light.
.
Standard_EXPORT void DeactivateGrid ()
 Deactivates the grid in all views of <me>.
.
Standard_EXPORT Quantity_PlaneAngle DefaultAngle () const
Standard_EXPORT Quantity_Color DefaultBackgroundColor () const
 Returns the default background colour object.
.
Standard_EXPORT 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.
.
Standard_EXPORT Standard_Boolean DefaultComputedMode () const
 returns true if by default the computed mode must be used.

Standard_EXPORT
Handle_V3d_OrthographicView 
DefaultOrthographicView ()
Standard_EXPORT
Handle_V3d_PerspectiveView 
DefaultPerspectiveView ()
Standard_EXPORT
V3d_TypeOfShadingModel 
DefaultShadingModel () const
 Returns the default type of Shading
.
Standard_EXPORT
V3d_TypeOfSurfaceDetail 
DefaultSurfaceDetail () const
 Returns the default type of texture mapping
.
Standard_EXPORT
V3d_TypeOfOrientation 
DefaultViewProj () const
 Returns the default Projection.
.
Standard_EXPORT Quantity_Length DefaultViewSize () const
 Returns the default size of the view.
.
Standard_EXPORT
V3d_TypeOfVisualization 
DefaultVisualization () const
 Returns the default type of Visualization.
.
Standard_EXPORT Handle_V3d_Light DefinedLight () const
Standard_EXPORT Handle_V3d_Plane DefinedPlane () const
Standard_EXPORT Handle_V3d_View DefinedView () const
virtual Standard_EXPORT void Delete () const
 Memory deallocator for transient classes.
Standard_EXPORT void DelLight (const Handle(V3d_Light)&MyLight)
 Delete Light in Sequence Of Lights.
.
Standard_EXPORT
Handle_Aspect_GraphicDevice 
Device () const
Standard_EXPORT void DisplayPrivilegedPlane (const Standard_Boolean OnOff, const Quantity_Length aSize=1)
Standard_EXPORT Standard_CString Domain () const
virtual Standard_EXPORT const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object.
virtual Standard_EXPORT const
Handle_Standard_Type & 
DynamicType () const
 Returns a type information object about this object.
Standard_EXPORT void Erase () const
 Erase all Objects in All the views.
.
Standard_EXPORT Standard_Integer GetRefCount () const
 Get the reference counter of this object.
Standard_EXPORT Standard_Integer GetRefCount () const
 Get the reference counter of this object.
Standard_EXPORT Handle_Aspect_Grid Grid () const
 Returns the defined grid in <me>.
.
Standard_EXPORT Aspect_GridDrawMode GridDrawMode () const
 Returns the current grid draw mode defined in <me>.
.
Standard_EXPORT Standard_Boolean GridEcho () const
Standard_EXPORT Aspect_GridType GridType () const
 Returns the current grid type defined in <me>.
.
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const
virtual Standard_EXPORT
Standard_Integer 
HashCode (const Standard_Integer Upper) const
virtual Standard_EXPORT
Standard_Integer 
HashCode (const Standard_Integer Upper) const
Standard_EXPORT Standard_Boolean IfMoreViews () const
Standard_EXPORT void Init ()
Standard_EXPORT void InitActiveLights ()
 initializes an iteration on the active Lights.

Standard_EXPORT void InitActiveViews ()
 initializes an iteration on the active views.

Standard_EXPORT void InitDefinedLights ()
 initializes an iteration on the Defined Lights.

Standard_EXPORT void InitDefinedPlanes ()
 initializes an iteration on the Defined Planes.

Standard_EXPORT void InitDefinedViews ()
 initializes an iteration on the Defined views.

Standard_EXPORT Standard_Boolean IsActive () const
 Returns Standard_True if a grid is activated in <me>.
.
Standard_EXPORT Standard_Boolean IsGlobalLight (const Handle(V3d_Light)&TheLight) const
Standard_EXPORT Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
Standard_EXPORT Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type.
Standard_EXPORT Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName.
Standard_EXPORT Standard_Boolean IsInstance (const Handle_Standard_Type &theType) const
 Returns a true value if this is an instance of Type.
Standard_EXPORT Standard_Boolean IsKind (const Standard_CString theTypeName) const
Standard_EXPORT Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
Standard_EXPORT Standard_Boolean IsKind (const Standard_CString theTypeName) const
Standard_EXPORT Standard_Boolean IsKind (const Handle_Standard_Type &theType) const
Standard_EXPORT Standard_Boolean LastActiveView () const
Standard_EXPORT Standard_Boolean MoreActiveLights () const
 returns true if there are more active Light(s) to return.

Standard_EXPORT Standard_Boolean MoreActiveViews () const
 returns true if there are more active view(s) to return.

Standard_EXPORT Standard_Boolean MoreDefinedLights () const
 returns true if there are more Defined Light(s) to return.

Standard_EXPORT Standard_Boolean MoreDefinedPlanes () const
 returns true if there are more Defined Plane(s) to return.

Standard_EXPORT Standard_Boolean MoreDefinedViews () const
 returns true if there are more Defined view(s) to return.

Standard_EXPORT void NextActiveLights ()
Standard_EXPORT void NextActiveViews ()
Standard_EXPORT void NextDefinedLights ()
Standard_EXPORT void NextDefinedPlanes ()
Standard_EXPORT void NextDefinedViews ()
Standard_EXPORT Standard_ExtString NextName () const
void operator delete (void *anAddress)
 Operator delete symmetric to operator new.
void operator delete (void *anAddress)
 Operator delete symmetric to operator new.
void * operator new (size_t size)
 Operator new for memory allocation uses Open CASCADE memory manager.
void * operator new (size_t, void *anAddress)
 Operator new for placement in pre-allocated memory.
void * operator new (size_t size)
 Operator new for memory allocation uses Open CASCADE memory manager.
void * operator new (size_t, void *anAddress)
 Operator new for placement in pre-allocated memory.
Standard_EXPORT gp_Ax3 PrivilegedPlane () const
Standard_EXPORT void RectangularGridGraphicValues (Quantity_Length &XSize, Quantity_Length &YSize, Quantity_Length &OffSet) const
 Returns the location and the size of the grid.
.
Standard_EXPORT 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.
.
Standard_EXPORT void Redraw () const
Standard_EXPORT void Remove ()
 Suppresses the Viewer.
.
Standard_EXPORT void SetCircularGridGraphicValues (const Quantity_Length Radius, const Quantity_Length OffSet)
Standard_EXPORT void SetCircularGridValues (const Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length RadiusStep, const Standard_Integer DivisionNumber, const Quantity_PlaneAngle RotationAngle)
Standard_EXPORT void SetCurrentSelectedLight (const Handle(V3d_Light)&TheLight)
 Defines the selected light.
.
Standard_EXPORT void SetDefaultAngle (const Quantity_PlaneAngle Angle)
Standard_EXPORT void SetDefaultBackgroundColor (const Quantity_Color &Color)
Standard_EXPORT void SetDefaultBackgroundColor (const Quantity_NameOfColor Name)
Standard_EXPORT void SetDefaultBackgroundColor (const Quantity_TypeOfColor Type, const Quantity_Parameter V1, const Quantity_Parameter V2, const Quantity_Parameter V3)
Standard_EXPORT void SetDefaultLights ()
Standard_EXPORT void SetDefaultShadingModel (const V3d_TypeOfShadingModel Type)
 Gives the default type of SHADING.
.
Standard_EXPORT void SetDefaultSurfaceDetail (const V3d_TypeOfSurfaceDetail Type)
 Gives the default type of texture mapping.
.
Standard_EXPORT void SetDefaultTypeOfView (const V3d_TypeOfView Type)
Standard_EXPORT void SetDefaultViewProj (const V3d_TypeOfOrientation Orientation)
Standard_EXPORT void SetDefaultViewSize (const Quantity_Length Size)
Standard_EXPORT void SetDefaultVisualization (const V3d_TypeOfVisualization Type)
 Gives the default visualisation mode..
.
Standard_EXPORT void SetGridEcho (const Handle(Graphic3d_AspectMarker3d)&aMarker)
Standard_EXPORT void SetGridEcho (const Standard_Boolean showGrid=Standard_True)
Standard_EXPORT void SetLightOff ()
 Deactivate all the Lights defined in this viewer.
.
Standard_EXPORT void SetLightOff (const Handle(V3d_Light)&MyLight)
 Desactivate MyLight in this viewer.
.
Standard_EXPORT void SetLightOn ()
 Activates all the lights defined in this viewer.
.
Standard_EXPORT void SetLightOn (const Handle(V3d_Light)&MyLight)
 Activates MyLight in the viewer.
.
Standard_EXPORT void SetPrivilegedPlane (const gp_Ax3 &aPlane)
Standard_EXPORT void SetRectangularGridGraphicValues (const Quantity_Length XSize, const Quantity_Length YSize, const Quantity_Length OffSet)
Standard_EXPORT void SetRectangularGridValues (const Quantity_Length XOrigin, const Quantity_Length YOrigin, const Quantity_Length XStep, const Quantity_Length YStep, const Quantity_PlaneAngle RotationAngle)
Standard_EXPORT void SetUpdateMode (const V3d_TypeOfUpdate Mode)
Standard_EXPORT void SetViewOff (const Handle(V3d_View)&View)
Standard_EXPORT void SetViewOff ()
Standard_EXPORT void SetViewOn (const Handle(V3d_View)&View)
Standard_EXPORT void SetViewOn ()
Standard_EXPORT void SetZBufferManagment (const Standard_Boolean Automatic)
virtual Standard_EXPORT void ShallowDump (Standard_OStream &) const
virtual Standard_EXPORT void ShallowDump (Standard_OStream &) const
virtual Standard_EXPORT
Handle_Standard_Transient 
This () const
virtual Standard_EXPORT
Handle_Standard_Transient 
This () const
Standard_EXPORT void UnHighlight () const
 UnHighlight all Objects in All the views.
.
Standard_EXPORT void Update ()
Standard_EXPORT void UpdateLights ()
 Updates the lights of all the views of a viewer.
.
Standard_EXPORT V3d_TypeOfUpdate UpdateMode () const
 Returns the regeneration mode of views in the viewer.
.
Standard_EXPORT 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)
Standard_EXPORT
Handle_Visual3d_ViewManager 
Viewer () const
 Returns the viewer associated to Visual3d .
.
Standard_EXPORT Standard_Boolean ZBufferManagment () const
 returns the ZBuffer stategy choice.


Protected Member Functions

Standard_EXPORT void IncrCount ()

Private Member Functions

Standard_EXPORT void AddLight (const Handle(V3d_Light)&MyLight)
 Adds Light in Sequence Of Lights.
.
Standard_EXPORT void AddPlane (const Handle(V3d_Plane)&MyPlane)
 Adds Plane in Sequence Of Planes.
.
Standard_EXPORT void AddView (const Handle(V3d_View)&MyView)
 Adds View in Sequence Of Views.
.
Standard_EXPORT void DelPlane (const Handle(V3d_Plane)&MyPlane)
 Delete Plane in Sequence Of Planes.
.
Standard_EXPORT void DelView (const Handle(V3d_View)&MyView)
 Delete View in Sequence Of Views.
.
Standard_EXPORT Aspect_Background GetBackgroundColor () const
 Returns the default background colour. .
.
Standard_EXPORT Standard_Boolean IsActive (const Handle(V3d_View)&aView) const
Standard_EXPORT void ShowGridEcho (const Handle(V3d_View)&aView, const Graphic3d_Vertex &aPoint)
 Display grid echo at requested point in the view.
.

Private Attributes

V3d_ListOfTransient MyActiveLights
TColStd_ListIteratorOfListOfTransient myActiveLightsIterator
V3d_ListOfTransient MyActiveViews
TColStd_ListIteratorOfListOfTransient myActiveViewsIterator
Aspect_Background MyBackground
Handle_V3d_CircularGrid myCGrid
Standard_Boolean myComputedMode
Handle_V3d_Light MyCurrentSelectedLight
Quantity_PlaneAngle MyDefaultAngle
Standard_Boolean myDefaultComputedMode
Handle_V3d_OrthographicView MyDefaultOrthographicView
Handle_V3d_PerspectiveView MyDefaultPerspectiveView
V3d_TypeOfView MyDefaultTypeOfView
V3d_ListOfTransient MyDefinedLights
TColStd_ListIteratorOfListOfTransient myDefinedLightsIterator
V3d_ListOfTransient MyDefinedPlanes
TColStd_ListIteratorOfListOfTransient myDefinedPlanesIterator
V3d_ListOfTransient MyDefinedViews
TColStd_ListIteratorOfListOfTransient myDefinedViewsIterator
Standard_Boolean myDisplayPlane
Quantity_Length myDisplayPlaneLength
Standard_Boolean myGridEcho
Handle_Graphic3d_AspectMarker3d myGridEchoAspect
Handle_Graphic3d_Group myGridEchoGroup
Handle_Graphic3d_Structure myGridEchoStructure
Aspect_GridType myGridType
Handle_Graphic3d_Structure myPlaneStructure
gp_Ax3 myPrivilegedPlane
Handle_V3d_RectangularGrid myRGrid
V3d_TypeOfShadingModel MyShadingModel
V3d_TypeOfSurfaceDetail MySurfaceDetail
Handle_Visual3d_ViewManager MyViewer
V3d_TypeOfOrientation MyViewProj
Standard_Real MyViewSize
V3d_TypeOfVisualization MyVisualization

Friends

Standard_EXPORT 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.

class V3d_Light
class V3d_Plane
class V3d_View

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

Generated by  Doxygen 1.6.0   Back to index