V2d_Viewer Class Reference

This class defines a 2D viewer which manages one
2D view at least and the attributes of this view (ex: ColorMap, etc.).

#include <V2d_Viewer.hxx>

Inheritance diagram for V2d_Viewer:

Public Member Functions
	V2d_Viewer (const Handle< Aspect_GraphicDevice > &aGraphicDevice, const Standard_ExtString aName, const Standard_CString aDomain="")
	Constructs a viewer object defined by the graphic device aGraphicDevice that determines the screen attributes, a default view and the name aName.
	V2d_Viewer (const Handle< Aspect_GraphicDevice > &aGraphicDevice, const Handle< Graphic2d_View > &aView, const Standard_ExtString aName, const Standard_CString aDomain="")
	Constructs a viewer object defined by the graphic device aGraphicDevice that determines the screen attributes, the first view aView and the name aName.
void	AddView (const Handle< V2d_View > &aView)
	Adds another 2D view to the viewer.
void	RemoveView (const Handle< V2d_View > &aView)
	Removes the view aView from the viewer.
void	Update ()
	Updates the display of all views of the viewer.
void	UpdateNew ()
	Updates the most recent changes in all the active views of the viewer.
void	SetColorMap (const Handle< Aspect_ColorMap > &aColorMap)
	Replaces the default color map of the viewer with the new color map aColorMap.
void	SetTypeMap (const Handle< Aspect_TypeMap > &aTypeMap)
	Replaces the default type map of the viewer with the new type map aTypeMap.
void	SetWidthMap (const Handle< Aspect_WidthMap > &aWidthMap)
	Replaces the default width map of the viewer with the new width map aWidthMap.
void	SetFontMap (const Handle< Aspect_FontMap > &aFontMap, const Standard_Boolean useMFT=Standard_True)
	Replaces the default font map of the viewer with the new font map aFontMap. When useMFT is equal to Standard_True, MDTV fonts are used instead of system fonts.
void	SetMarkMap (const Handle< Aspect_MarkMap > &aMarkMap)
	Replaces the default mark map of the viewer with the new mark map aMarkMap.
Handle_Aspect_ColorMap	ColorMap () const
	Returns the active color map of the viewer.
Handle_Aspect_TypeMap	TypeMap () const
	Returns the active type map of the viewer.
Handle_Aspect_WidthMap	WidthMap () const
	Returns the active width map of the viewer.
Handle_Aspect_FontMap	FontMap () const
	Returns the active font map for the viewer.
Handle_Aspect_MarkMap	MarkMap () const
	Returns the active mark map of the viewer.
Standard_Boolean	UseMFT () const
	Returns True when the viewer uses MFT fonts instead of system fonts.
Handle_Graphic2d_View	View () const
	Returns the first view of the viewer.
Standard_Integer	InitializeColor (const Quantity_NameOfColor aColor)
	Creates a color in the color map of the driver if the color does not yes exist. Returns the index of the color in the modified color map.
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_V2d_View	ActiveView () const
	Returns the current view from the activated views.
Standard_Boolean	IsEmpty () const
	Returns True when no more secondary views exist in the viewer.
Aspect_GridType	GridType () const
	returns the current grid type.
void	Hit (const Quantity_Length X, const Quantity_Length Y, Quantity_Length &gx, Quantity_Length &gy) const
	returns the point (gx,gy) according to the grid.
void	ActivateGrid (const Aspect_GridType aGridType, const Aspect_GridDrawMode aGridDrawMode)
void	DeactivateGrid ()
Standard_Boolean	IsActive () const
	Returns True when a grid is active in the viewer.
void	RectangularGridValues (Quantity_Length &XOrigin, Quantity_Length &YOrigin, Quantity_Length &XStep, Quantity_Length &YStep, Quantity_PlaneAngle &RotationAngle) const
	Returns the parameters of the current 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 rectangular grid:
void	CircularGridValues (Quantity_Length &XOrigin, Quantity_Length &YOrigin, Quantity_Length &RadiusStep, Standard_Integer &DivisionNumber, Quantity_PlaneAngle &RotationAngle) const
	Returns the parameters of the current 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 circular grid:
void	SetGridColor (const Quantity_Color &color1, const Quantity_Color &color2)

---

Constructor & Destructor Documentation

V2d_Viewer::V2d_Viewer	(	const Handle< Aspect_GraphicDevice > &	aGraphicDevice,
		const Standard_ExtString	aName,
		const Standard_CString	aDomain = ""
	)

V2d_Viewer::V2d_Viewer	(	const Handle< Aspect_GraphicDevice > &	aGraphicDevice,
		const Handle< Graphic2d_View > &	aView,
		const Standard_ExtString	aName,
		const Standard_CString	aDomain = ""
	)

---

Member Function Documentation

void V2d_Viewer::ActivateGrid	(	const Aspect_GridType	aGridType,
		const Aspect_GridDrawMode	aGridDrawMode
	)

Handle_V2d_View V2d_Viewer::ActiveView

(

)

const

void V2d_Viewer::AddView

(

const Handle< V2d_View > &

aView

)

void V2d_Viewer::CircularGridValues	(	Quantity_Length &	XOrigin,
		Quantity_Length &	YOrigin,
		Quantity_Length &	RadiusStep,
		Standard_Integer &	DivisionNumber,
		Quantity_PlaneAngle &	RotationAngle
	)		const

Handle_Aspect_ColorMap V2d_Viewer::ColorMap

(

)

const

void V2d_Viewer::DeactivateGrid

(

)

Handle_Aspect_FontMap V2d_Viewer::FontMap

(

)

const

Aspect_GridType V2d_Viewer::GridType

(

)

const

void V2d_Viewer::Hit	(	const Quantity_Length	X,
		const Quantity_Length	Y,
		Quantity_Length &	gx,
		Quantity_Length &	gy
	)		const

void V2d_Viewer::InitActiveViews

(

)

Standard_Integer V2d_Viewer::InitializeColor

(

const Quantity_NameOfColor

aColor

)

Standard_Boolean V2d_Viewer::IsActive

(

)

const

Standard_Boolean V2d_Viewer::IsEmpty

(

)

const

Handle_Aspect_MarkMap V2d_Viewer::MarkMap

(

)

const

Standard_Boolean V2d_Viewer::MoreActiveViews

(

)

const

void V2d_Viewer::NextActiveViews

(

)

void V2d_Viewer::RectangularGridValues	(	Quantity_Length &	XOrigin,
		Quantity_Length &	YOrigin,
		Quantity_Length &	XStep,
		Quantity_Length &	YStep,
		Quantity_PlaneAngle &	RotationAngle
	)		const

void V2d_Viewer::RemoveView

(

const Handle< V2d_View > &

aView

)

void V2d_Viewer::SetCircularGridValues	(	const Quantity_Length	XOrigin,
		const Quantity_Length	YOrigin,
		const Quantity_Length	RadiusStep,
		const Standard_Integer	DivisionNumber,
		const Quantity_PlaneAngle	RotationAngle
	)

• XOrigin, YOrigin specify the origin of the grid,
  
• RadiusStep defines the interval between two circles,
  
• DivisionNumber determines the section number of half a circle,
  
• RotationAngle defines the rotation angle of the grid.
  

void V2d_Viewer::SetColorMap

(

const Handle< Aspect_ColorMap > &

aColorMap

)

void V2d_Viewer::SetFontMap	(	const Handle< Aspect_FontMap > &	aFontMap,
		const Standard_Boolean	useMFT = Standard_True
	)

void V2d_Viewer::SetGridColor	(	const Quantity_Color &	color1,
		const Quantity_Color &	color2
	)

void V2d_Viewer::SetMarkMap

(

const Handle< Aspect_MarkMap > &

aMarkMap

)

void V2d_Viewer::SetRectangularGridValues	(	const Quantity_Length	XOrigin,
		const Quantity_Length	YOrigin,
		const Quantity_Length	XStep,
		const Quantity_Length	YStep,
		const Quantity_PlaneAngle	RotationAngle
	)

• XOrigin, YOrigin define the point of origin of the grid,
  
• XStep defines the interval between two vertical lines,
  
• YStep defines the interval between two horizontal lines,
  
• RotationAngle defines the rotation angle of the grid.
  

void V2d_Viewer::SetTypeMap

(

const Handle< Aspect_TypeMap > &

aTypeMap

)

void V2d_Viewer::SetWidthMap

(

const Handle< Aspect_WidthMap > &

aWidthMap

)

Handle_Aspect_TypeMap V2d_Viewer::TypeMap

(

)

const

void V2d_Viewer::Update

(

)

[virtual]

Implements Viewer_Viewer.

void V2d_Viewer::UpdateNew

(

)

Standard_Boolean V2d_Viewer::UseMFT

(

)

const

Handle_Graphic2d_View V2d_Viewer::View

(

)

const

Handle_Aspect_WidthMap V2d_Viewer::WidthMap

(

)

const

---

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

• V2d_Viewer.hxx