Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions | Static Public Member Functions | Protected Member Functions
WNT_DDriver Class Reference

Defines the device-independent Windows NT driver.
After graphics output enhanced metafile will be created.
It is possible to play this file on device several times
by Spool () method.

#include <WNT_DDriver.hxx>

Inheritance diagram for WNT_DDriver:
Inheritance graph
[legend]

Public Member Functions

 WNT_DDriver (const Standard_CString aDeviceName, const Standard_CString aFileName, const WNT_OrientationType anOrientation=WNT_OT_LANDSCAPE, const Quantity_Factor aScale=1.0, const Standard_Integer aCopies=1)
 Constructs a device driver framework defined by the
string aDeviceName, the path specified as an
argument for OSD_Path, the type of orientation
anOrientation, the scale aScale, the number of copies
aCopies and the flag aPrintFlag.

 WNT_DDriver (const Standard_CString aFileName, const Standard_Integer aCopies=1)
 Creates the class object. An empty path is authorized
and in this case, a temporary enhanced metafile is
created. You can delete this file by using the EndDraw function.
Warning - OSD_Path corresponds to an ASCII string.
Exceptions
Aspect_DriverDefinitionError if the driver could not be defined.

virtual void Close ()
 ~WNT_DDriver ()
virtual void BeginDraw ()
 Begins a new picture of graphics in the enhanced metafile

virtual void EndDraw (const Standard_Boolean fSynchronize=Standard_False)
 Flushes all graphics, closes enhanced metafile.

virtual Standard_Boolean Spool (const Aspect_PlotMode aPlotMode=Aspect_PM_FILEONLY, const Standard_CString aDeviceName=NULL, const Standard_Boolean anOriginalSize=Standard_False)
 Spools the driver onto a printer spool.
Stretches the picture so that it fits into the device
workspace if the Boolean anOriginalSize is False
and the workspace dimensions of the original
device differ from those of the current device. This
flag is ignored if aDeviceName is NULL.
Warning
If aDeviceName is NULL, then the driver should be
created with the first constructor. Otherwise, use
the second constructor to create a class object.
Exceptions
Aspect_DriverError if the driver is not correctly defined.

virtual void SetLineAttrib (const Standard_Integer ColorIndex, const Standard_Integer TypeIndex, const Standard_Integer WidthIndex)
 Defines the Current Line Attibutes

virtual void SetTextAttrib (const Standard_Integer ColorIndex, const Standard_Integer FontIndex)
 Defines the Current Text Attributes

virtual void SetTextAttrib (const Standard_Integer ColorIndex, const Standard_Integer FontIndex, const Quantity_PlaneAngle aSlant, const Quantity_Factor aHScale, const Quantity_Factor aWScale, const Standard_Boolean isUnderlined=Standard_False)
 Defines the Current Extended Text Attributes

virtual void SetPolyAttrib (const Standard_Integer ColorIndex, const Standard_Integer TileIndex, const Standard_Boolean DrawEdge=Standard_False)
 Sets the poly attributes

virtual void SetMarkerAttrib (const Standard_Integer ColorIndex, const Standard_Integer WidthIndex, const Standard_Boolean FillMarker=Standard_False)
 Defines the Current Marker Attributes

virtual Standard_Boolean IsKnownImage (const Handle< Standard_Transient > &anImage)
virtual Standard_Boolean SizeOfImageFile (const Standard_CString anImageFile, Standard_Integer &aWidth, Standard_Integer &aHeight) const
 Returns Standard_True and the Image Size in PIXEL
if the image file exist and can be computed by the driver,

virtual void ClearImage (const Handle< Standard_Transient > &anImageId)
virtual void ClearImageFile (const Standard_CString anImageFile)
 Clears the image associated with the image file .

virtual void DrawImage (const Handle< Standard_Transient > &anImageId, const Standard_ShortReal aX, const Standard_ShortReal aY)
 Draws the image in <me>.
<aX>, <aY> is the center of the image.
Image center must be defined in DPU space.

virtual void DrawImageFile (const Standard_CString anImageFile, const Standard_ShortReal aX, const Standard_ShortReal aY, const Quantity_Factor aScale=1.0)
 Draws the image file in <me>.
<aX>, <aY> is the center of the image.
Image center must be defined in DPU space.

virtual void FillAndDrawImage (const Handle< Standard_Transient > &anImageId, const Standard_ShortReal aX, const Standard_ShortReal aY, const Standard_Integer aWidth, const Standard_Integer aHeight, const Standard_Address anArrayOfPixels)
 Fills a complete Image .

virtual void FillAndDrawImage (const Handle< Standard_Transient > &anImageId, const Standard_ShortReal aX, const Standard_ShortReal aY, const Standard_Integer anIndexOfLine, const Standard_Integer aWidth, const Standard_Integer aHeight, const Standard_Address anArrayOfPixels)
 Fills a line of the Image .
Warning: 0 <= anIndexOfLine < aHeight
anIndexOfLine = 0 must be the first call

void BeginPolyline (const Standard_Integer aNumber)
 Begin an incremental polyline primitive of <aNumber> of points
Warning: Points must be added by the the DrawPoint() method.

virtual void BeginPolygon (const Standard_Integer aNumber)
 Begin an incremental polygon primitive of <aNumber> of points
Warning: Points must be added by the the DrawPoint() method.

virtual void BeginSegments ()
 Begin a set of segments .
Warning: Segments must be added by the DrawSegment() method

virtual void BeginArcs ()
 Begin a set of circles or ellips .
Warning: Arcs must be added by the DrawArc() methods

virtual void BeginPolyArcs ()
 Begin a set of polygon circles or ellips
Warning: Arcs must be added by the DrawPolyArc() methods

virtual void BeginMarkers ()
 Begin a set of markers .
Warning: Markers must be added by the DrawMarker() method

virtual void BeginPoints ()
 Begin a set of points .
Warning: Points must be added by the DrawPoint() method

void ClosePrimitive ()
 Close the last Begining primitive

void WorkSpace (Quantity_Length &Width, Quantity_Length &Heigth) const
 Returns the Available WorkSpace in DWU coordinates

Quantity_Length Convert (const Standard_Integer PV) const
 Returns the DWU value depending of
the PIXEL value.

Standard_Integer Convert (const Quantity_Length DV) const
 Returns the PIXEL value depending of the DWU value.

void Convert (const Standard_Integer PX, const Standard_Integer PY, Quantity_Length &DX, Quantity_Length &DY) const
 Returns the DWU position depending of the PIXEL position .

void Convert (const Quantity_Length DX, const Quantity_Length DY, Standard_Integer &PX, Standard_Integer &PY) const
 Returns the PIXEL position depending of the DWU position

void TextSize (const TCollection_ExtendedString &aText, Standard_ShortReal &aWidth, Standard_ShortReal &aHeight, const Standard_Integer aFontIndex=-1) const
 Returns the TEXT size in DWU space depending
of the required FontIndex if aFontIndex is >= 0
or the current FontIndex if < 0 (default).

void TextSize (const TCollection_ExtendedString &aText, Standard_ShortReal &aWidth, Standard_ShortReal &aHeight, Standard_ShortReal &anXoffset, Standard_ShortReal &anYoffset, const Standard_Integer aFontIndex=-1) const
 Returns the TEXT size and offsets
in DWU space depending
of the required FontIndex if aFontIndex is >= 0
or the current FontIndex if < 0 (default).

void TextSize (const Standard_CString aText, Standard_ShortReal &aWidth, Standard_ShortReal &aHeight, Standard_ShortReal &anXoffset, Standard_ShortReal &anYoffset, const Standard_Integer aFontIndex=-1) const
 Returns the TEXT size in DWU space depending
of the required FontIndex if aFontIndex is >= 0
or the current FontIndex if < 0 (default).

Aspect_Handle HDC () const
 Returns device context handle

void ClientRect (Standard_Integer &aWidth, Standard_Integer &aHeigth) const
 Returns dimensions of the device

Handle_WNT_GraphicDevice GraphicDevice () const
 Returns graphic device

Standard_Real EMFDim (Standard_Integer &aWidth, Standard_Integer &aHeight, Standard_Integer &aSwap)
 returns dimensions, in .01 millimeter units,
of a rectangle that surrounds the picture stored
in the metafile ( parameters <aWidth> & <aHeight> ).
<aSwap> value idicates whether rotate operation
(portrait/landscape) was performed or not. Valid
values are: <0> - no rotation
<1> - do rotation
<2> - could not determine
Returns ratio between <aWidth> & <aHeight>.
Warning: returns <-1> in case of error

const Handle_WNT_TextManager & TextManager ()
const Handle_MFT_FontManager & MFT_Font (const Standard_Integer anIndex)
Standard_ShortReal MFT_Size (const Standard_Integer anIndex)

Static Public Member Functions

static
Handle_TColStd_HSequenceOfAsciiString 
DeviceList ()
 Returns list of available graphic devices.
First element is default device

static void DeviceSize (const TCollection_AsciiString &aDevice, Standard_Real &aWidth, Standard_Real &aHeight)
 Returns size of a specified device.

Protected Member Functions

virtual Standard_Boolean PlotPolyline (const Standard_Address xArray, const Standard_Address yArray, const Standard_Address nPts, const Standard_Integer nParts)
 Draws a polyline depending of the SetLineAttrib() attributes.

virtual Standard_Boolean PlotPolygon (const Standard_Address xArray, const Standard_Address yArray, const Standard_Address nPts, const Standard_Integer nParts)
 Draws a polygon depending of the SetPolyAttrib() attributes.

virtual Standard_Boolean PlotSegment (const Standard_ShortReal X1, const Standard_ShortReal Y1, const Standard_ShortReal X2, const Standard_ShortReal Y2)
 Draws a segment depending of the SetLineAttrib() attributes.

virtual Standard_Boolean PlotText (const TCollection_ExtendedString &aText, const Standard_ShortReal Xpos, const Standard_ShortReal Ypos, const Standard_ShortReal anAngle=0.0, const Aspect_TypeOfText aType=Aspect_TOT_SOLID)
 Draws a text depending of the SetTextAttrib() attributes.
Warning: Coordinates must be defined in DWU space.

virtual Standard_Boolean PlotText (const Standard_CString aText, const Standard_ShortReal Xpos, const Standard_ShortReal Ypos, const Standard_ShortReal anAngle=0.0, const Aspect_TypeOfText aType=Aspect_TOT_SOLID)
 Draws a text depending of the SetTextAttrib() attributes.
Warning: Coordinates must be defined in DWU space.

virtual Standard_Boolean PlotPolyText (const TCollection_ExtendedString &aText, const Standard_ShortReal Xpos, const Standard_ShortReal Ypos, const Quantity_Ratio aMarge=0.1, const Standard_ShortReal anAngle=0.0, const Aspect_TypeOfText aType=Aspect_TOT_SOLID)
 Draws an framed text depending of the
SetTextAttrib() and SetPolyAttrib() attributes.
Warning: Coordinates must be defined in DWU space.
<aMarge> defines the ratio of the space between the
polygon borders and the bounding box of the text and
depending of the height of the text.

virtual Standard_Boolean PlotPolyText (const Standard_CString aText, const Standard_ShortReal Xpos, const Standard_ShortReal Ypos, const Quantity_Ratio aMarge=0.1, const Standard_ShortReal anAngle=0.0, const Aspect_TypeOfText aType=Aspect_TOT_SOLID)
 Draws an framed text depending of the
SetTextAttrib() and SetPolyAttrib() attributes.
Warning: Coordinates must be defined in DWU space.
<aMarge> defines the ratio of the space between the
polygon borders and the bounding box of the text and
depending of the height of the text.

virtual Standard_Boolean PlotPoint (const Standard_ShortReal X, const Standard_ShortReal Y)
 Draws a 1 PIXEL point depending of the SetMarkerAttrib()
color attribute or add a point depending of the incremental BeginXxxxxx()
primitive used.

virtual Standard_Boolean PlotMarker (const Standard_Integer aMarker, const Standard_ShortReal Xpos, const Standard_ShortReal Ypos, const Standard_ShortReal Width, const Standard_ShortReal Height, const Standard_ShortReal Angle=0.0)
 Draws the prevously defined marker <aMarker>
depending of the SetMarkerAttrib() attributes.
Warning: Coordinates and sizes must be defined in DWU space.
Angle must be defined in RADIAN.
A one pixel marker is drawn when aMarker index is undefined

virtual Standard_Boolean PlotArc (const Standard_ShortReal X, const Standard_ShortReal Y, const Standard_ShortReal anXradius, const Standard_ShortReal anYradius, const Standard_ShortReal aStartAngle=0.0, const Standard_ShortReal anOpenAngle=6.283185)
 Draws an Ellipsoid arc of center <X,Y> and Radius
<anXradius,anYradius> of relative angle <anOpenAngle> from
the base angle <aStartAngle> and depending of the SetLineAttrib() attributes

virtual Standard_Boolean PlotPolyArc (const Standard_ShortReal X, const Standard_ShortReal Y, const Standard_ShortReal anXradius, const Standard_ShortReal anYradius, const Standard_ShortReal aStartAngle=0.0, const Standard_ShortReal anOpenAngle=6.283185)
 Draws an filled Ellipsoid arc of center <X,Y> and Radius
<anXradius,anYradius> of relative angle <anOpenAngle> from
the base angle <aStartAngle> and depending of the SetPolyAttrib() attributes.

virtual void InitializeColorMap (const Handle< Aspect_ColorMap > &aColorMap)
virtual void InitializeTypeMap (const Handle< Aspect_TypeMap > &aTypeMap)
virtual void InitializeWidthMap (const Handle< Aspect_WidthMap > &aWidthMap)
virtual void InitializeFontMap (const Handle< Aspect_FontMap > &aFontMap)
virtual void InitializeMarkMap (const Handle< Aspect_MarkMap > &aFontMap)

Constructor & Destructor Documentation


Member Function Documentation

virtual void WNT_DDriver::BeginArcs ( ) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::BeginDraw ( ) [virtual]

Implements PlotMgt_PlotterDriver.

virtual void WNT_DDriver::BeginMarkers ( ) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::BeginPoints ( ) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::BeginPolyArcs ( ) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::BeginPolygon ( const Standard_Integer  aNumber) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::BeginSegments ( ) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::ClearImage ( const Handle< Standard_Transient > &  anImageId) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::ClearImageFile ( const Standard_CString  anImageFile) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

void WNT_DDriver::ClientRect ( Standard_Integer aWidth,
Standard_Integer aHeigth 
) const
virtual void WNT_DDriver::Close ( ) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

static Handle_TColStd_HSequenceOfAsciiString WNT_DDriver::DeviceList ( ) [static]
static void WNT_DDriver::DeviceSize ( const TCollection_AsciiString aDevice,
Standard_Real aWidth,
Standard_Real aHeight 
) [static]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::EndDraw ( const Standard_Boolean  fSynchronize = Standard_False) [virtual]

Implements Aspect_Driver.

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::FillAndDrawImage ( const Handle< Standard_Transient > &  anImageId,
const Standard_ShortReal  aX,
const Standard_ShortReal  aY,
const Standard_Integer  anIndexOfLine,
const Standard_Integer  aWidth,
const Standard_Integer  aHeight,
const Standard_Address  anArrayOfPixels 
) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

Handle_WNT_GraphicDevice WNT_DDriver::GraphicDevice ( ) const
virtual void WNT_DDriver::InitializeColorMap ( const Handle< Aspect_ColorMap > &  aColorMap) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::InitializeFontMap ( const Handle< Aspect_FontMap > &  aFontMap) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::InitializeMarkMap ( const Handle< Aspect_MarkMap > &  aFontMap) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::InitializeTypeMap ( const Handle< Aspect_TypeMap > &  aTypeMap) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::InitializeWidthMap ( const Handle< Aspect_WidthMap > &  aWidthMap) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

const Handle_MFT_FontManager& WNT_DDriver::MFT_Font ( const Standard_Integer  anIndex)
virtual Standard_Boolean WNT_DDriver::PlotArc ( const Standard_ShortReal  X,
const Standard_ShortReal  Y,
const Standard_ShortReal  anXradius,
const Standard_ShortReal  anYradius,
const Standard_ShortReal  aStartAngle = 0.0,
const Standard_ShortReal  anOpenAngle = 6.283185 
) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

virtual Standard_Boolean WNT_DDriver::PlotPolyArc ( const Standard_ShortReal  X,
const Standard_ShortReal  Y,
const Standard_ShortReal  anXradius,
const Standard_ShortReal  anYradius,
const Standard_ShortReal  aStartAngle = 0.0,
const Standard_ShortReal  anOpenAngle = 6.283185 
) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual Standard_Boolean WNT_DDriver::PlotPolygon ( const Standard_Address  xArray,
const Standard_Address  yArray,
const Standard_Address  nPts,
const Standard_Integer  nParts 
) [protected, virtual]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::SetLineAttrib ( const Standard_Integer  ColorIndex,
const Standard_Integer  TypeIndex,
const Standard_Integer  WidthIndex 
) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::SetMarkerAttrib ( const Standard_Integer  ColorIndex,
const Standard_Integer  WidthIndex,
const Standard_Boolean  FillMarker = Standard_False 
) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::SetPolyAttrib ( const Standard_Integer  ColorIndex,
const Standard_Integer  TileIndex,
const Standard_Boolean  DrawEdge = Standard_False 
) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::SetTextAttrib ( const Standard_Integer  ColorIndex,
const Standard_Integer  FontIndex 
) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual void WNT_DDriver::SetTextAttrib ( const Standard_Integer  ColorIndex,
const Standard_Integer  FontIndex,
const Quantity_PlaneAngle  aSlant,
const Quantity_Factor  aHScale,
const Quantity_Factor  aWScale,
const Standard_Boolean  isUnderlined = Standard_False 
) [virtual]

Reimplemented from PlotMgt_PlotterDriver.

virtual Standard_Boolean WNT_DDriver::SizeOfImageFile ( const Standard_CString  anImageFile,
Standard_Integer aWidth,
Standard_Integer aHeight 
) const [virtual]

Reimplemented from PlotMgt_PlotterDriver.

Reimplemented from PlotMgt_PlotterDriver.

const Handle_WNT_TextManager& WNT_DDriver::TextManager ( )
void WNT_DDriver::TextSize ( const TCollection_ExtendedString aText,
Standard_ShortReal aWidth,
Standard_ShortReal aHeight,
Standard_ShortReal anXoffset,
Standard_ShortReal anYoffset,
const Standard_Integer  aFontIndex = -1 
) const
void WNT_DDriver::TextSize ( const Standard_CString  aText,
Standard_ShortReal aWidth,
Standard_ShortReal aHeight,
Standard_ShortReal anXoffset,
Standard_ShortReal anYoffset,
const Standard_Integer  aFontIndex = -1 
) const
void WNT_DDriver::WorkSpace ( Quantity_Length Width,
Quantity_Length Heigth 
) const [virtual]

Reimplemented from PlotMgt_PlotterDriver.


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