#include <GiCommonDraw.h>

Inheritance diagram for OdGiContext:

Public Types
enum	ImageQuality { kImageQualityDraft = 0 , kImageQualityHigh = 1 }

enum	ImageSelectionFlags { kImageHighlight = (1 << 0) , kImageSelect = (1 << 1) }

enum	FadingType { kLockedLayerFade = 0 , kXrefFade = 1 , kRefEditFade = 2 }

enum	GlyphType { kLightGlyph = 0 , kCameraGlyph = 1 }

enum	LineWeightStyle { kPointLineWeight = 0 , kLineCapStyle = 1 , kLineJoinStyle = 2 }

enum	CoordinatesSystem { kWCS = 0 , kECS = 1 , kNDC = 2 , kDCS = 3 }

enum	DrawableFilterInputFlags { kNestedDrawable = 0x1000000 }

enum	DrawableFilterOutputFlags { kSkipVectorization = 1 }

enum	DrawableFilterRanges { kDrawableFilterAppRangeStart = 0x1000000 , kDrawableFilterAppRangeMask = (OdInt32)0xFF000000 }

enum	PStyleType { kPsNone = 0 , kPsByColor = 1 , kPsByName = 2 }

enum	SilhouetteType { kNoSilhouettes = 0 , kMeshSilhouettes = (1 << 0) , kModelerSilhouettes = (1 << 1) , kAllSilhouettes = kMeshSilhouettes \| kModelerSilhouettes }

Public Member Functions
	ODRX_DECLARE_MEMBERS (OdGiContext)

virtual OdDbBaseDatabase *	database () const =0

virtual OdGiDrawablePtr	openDrawable (OdDbStub *drawableId)=0

virtual OdDb::LineWeight	defaultLineWeight () const

virtual double	commonLinetypeScale () const

virtual void	getDefaultTextStyle (OdGiTextStyle &textStyle)

virtual void	drawShape (OdGiCommonDraw pDraw, OdGePoint3d &position, int shapeNumber, const OdGiTextStyle pTextStyle)

virtual void	drawShape (OdGiConveyorGeometry pDest, const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector, int shapeNumber, const OdGiTextStyle pTextStyle, const OdGeVector3d *pExtrusion)

virtual void	drawText (OdGiCommonDraw pDraw, OdGePoint3d &position, const OdChar msg, OdInt32 numBytes, const OdGiTextStyle *pTextStyle, OdUInt32 flags=0)

virtual void	drawText (OdGiCommonDraw *pDraw, OdGePoint3d &position, double height, double width, double oblique, const OdString &msg)

virtual void	drawText (OdGiConveyorGeometry pDest, const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector, const OdChar msg, OdInt32 numBytes, bool raw, const OdGiTextStyle pTextStyle, const OdGeVector3d pExtrusion)

virtual void	textExtentsBox (const OdGiTextStyle &textStyle, const OdChar msg, int nLength, OdUInt32 flags, OdGePoint3d &min, OdGePoint3d &max, OdGePoint3d pEndPos=0)

virtual void	shapeExtentsBox (const OdGiTextStyle &textStyle, int shapeNumber, OdGePoint3d &min, OdGePoint3d &max)

virtual unsigned int	circleZoomPercent (OdDbStub *viewportId) const

virtual bool	isPlotGeneration () const

virtual ODCOLORREF	paletteBackground () const

virtual bool	fillTtf () const

virtual OdUInt32	numberOfIsolines () const

virtual bool	fillMode () const

virtual bool	quickTextMode () const

virtual OdUInt32	textQuality () const

virtual bool	useTtfTriangleCache () const

virtual ImageQuality	imageQuality () const

virtual OdUInt32	imageSelectionBehavior () const

virtual OdUInt32	fadingIntensityPercentage (FadingType fadingType) const

virtual OdUInt32	glyphSize (GlyphType glyphType) const

virtual OdUInt32	lineWeightConfiguration (LineWeightStyle styleEntry) const

virtual OdUInt32	selectionStyle (OdUInt32 nStyle, OdGiSelectionStyle &selStyle) const

virtual CoordinatesSystem	customViewportGeometryCS (CoordinatesSystem csType) const

virtual OdIntPtr	drawableFilterFunctionId (OdDbStub *viewportId) const

virtual OdUInt32	drawableFilterFunction (OdIntPtr functionId, const OdGiDrawable *pDrawable, OdUInt32 nFlags)

virtual bool	ttfPolyDraw () const

virtual bool	regenAbort () const

virtual PStyleType	plotStyleType () const

virtual void	plotStyle (int penNumber, OdPsPlotStyleData &plotStyleData) const

virtual void	plotStyle (OdDbStub *objectId, OdPsPlotStyleData &plotStyleData) const

virtual OdDbStub *	getStubByID (OdUInt64 persistentId) const

virtual OdUInt64	getIDByStub (OdDbStub *objectId) const

virtual OdDbBaseDatabase *	getDatabaseByStub (OdDbStub *objectId) const

virtual OdDbStub *	getOwnerIDByStub (OdDbStub *objectId) const

virtual OdDbStub *	getStubByMatName (OdDbBaseDatabase *pBaseDb, const OdString &strMatName) const

virtual OdDbStub *	getStubByMaterialId (OdDbBaseDatabase *pBaseDb, const OdUInt64 &materialId) const

virtual OdUInt32	displaySilhouettes () const

bool	displayMeshSilhouettes () const

bool	displayModelerSilhouettes () const

virtual OdGiSectionGeometryManagerPtr	getSectionGeometryManager ()

virtual OdUInt32	antiAliasingMode () const

virtual bool	xrefPropertiesOverride () const

virtual bool	multiplyByBlockLinetypeScales () const

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

virtual void	addRef ()=0

virtual void	release ()=0

virtual long	numRefs () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () const

virtual void	copyFrom (const OdRxObject *pSource)

virtual OdRx::Ordering	comparedTo (const OdRxObject *pOther) const

virtual bool	isEqualTo (const OdRxObject *pOther) const

Additional Inherited Members
Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Detailed Description

This class defines common operations and properties that are used in the ODA Platform vectorization process.

Remarks: An instance of an OdGiContext subclass is normally created as a preliminary step in the vectorization process, which is to be used throughout the vectorization.

Most of the virtual functions in this class (the ones that are not pure virtual) are no-ops, serving only to define an interface.

Corresponding C++ library: TD_Gi

Definition at line 112 of file GiCommonDraw.h.

Member Enumeration Documentation

◆ CoordinatesSystem

enum OdGiContext::CoordinatesSystem

Defines coordinate systems.

Enumerator
kWCS	World Coordinates System.
kECS	Eye Coordinates System.
kNDC	Normalized Device Coordinates (in 0-1 range).
kDCS	Device Coordinates System (in pixels).

Definition at line 497 of file GiCommonDraw.h.

◆ DrawableFilterInputFlags

enum OdGiContext::DrawableFilterInputFlags

Input flags of drawable filter.

Enumerator
kNestedDrawable

Definition at line 524 of file GiCommonDraw.h.

◆ DrawableFilterOutputFlags

enum OdGiContext::DrawableFilterOutputFlags

Output flags of drawable filter.

Enumerator
kSkipVectorization

Definition at line 532 of file GiCommonDraw.h.

◆ DrawableFilterRanges

enum OdGiContext::DrawableFilterRanges

Ranges of drawable filter.

Enumerator
kDrawableFilterAppRangeStart
kDrawableFilterAppRangeMask

Definition at line 540 of file GiCommonDraw.h.

◆ FadingType

enum OdGiContext::FadingType

Fading types.

Enumerator
kLockedLayerFade
kXrefFade
kRefEditFade

Definition at line 411 of file GiCommonDraw.h.

◆ GlyphType

enum OdGiContext::GlyphType

Glyph types.

Enumerator
kLightGlyph
kCameraGlyph

Definition at line 431 of file GiCommonDraw.h.

◆ ImageQuality

enum OdGiContext::ImageQuality

Image quality types.

Enumerator
kImageQualityDraft
kImageQualityHigh

Definition at line 377 of file GiCommonDraw.h.

◆ ImageSelectionFlags

enum OdGiContext::ImageSelectionFlags

Raster image flags.

Enumerator
kImageHighlight
kImageSelect

Definition at line 394 of file GiCommonDraw.h.

◆ LineWeightStyle

enum OdGiContext::LineWeightStyle

Lineweight styles.

Enumerator
kPointLineWeight
kLineCapStyle
kLineJoinStyle

Definition at line 457 of file GiCommonDraw.h.

◆ PStyleType

enum OdGiContext::PStyleType

Plot style types.

Enumerator
kPsNone
kPsByColor
kPsByName

Definition at line 595 of file GiCommonDraw.h.

◆ SilhouetteType

enum OdGiContext::SilhouetteType

Silhouette types.

Enumerator
kNoSilhouettes
kMeshSilhouettes
kModelerSilhouettes
kAllSilhouettes

Definition at line 700 of file GiCommonDraw.h.

Member Function Documentation

◆ antiAliasingMode()

virtual OdUInt32 OdGiContext::antiAliasingMode ( ) const

virtual

Receives rendering anti-aliasing settings.

Returns: 0.

Reimplemented in OdGiContextForDbDatabase.

◆ circleZoomPercent()

virtual unsigned int OdGiContext::circleZoomPercent ( OdDbStub * viewportId ) const

virtual

Retrieves the circle zoom percent for this vectorization process.

Parameters

viewportId [in] Pointer to the Object ID of the Viewport object to be queried.

Returns: Retrieves a value in the range [1,20000]. 100 is the default.

Reimplemented in OdGiContextForDbDatabase.

◆ commonLinetypeScale()

virtual double OdGiContext::commonLinetypeScale ( ) const

virtual

Retrieves the common linetype scale for this Context object.

Returns: common scale of linetypes.

Reimplemented in OdGiContextForDbDatabase.

◆ customViewportGeometryCS()

virtual CoordinatesSystem OdGiContext::customViewportGeometryCS ( CoordinatesSystem csType ) const

virtual

Specifies behavior of OdGiViewportGeometry::polylineEye/polygonEye/polylineDc/polygonDc methods.

Parameters

csType [in] If specified kECS - return coordinates system for polylineEye/polygonEye methods. If specified kNDC or kDCS - return coordinates system for polylineDc/polygonDc methods. Other argument types ingored and return coordinates system as is (kWCS for kWCS for example).

Returns: Coordinates system for specified input coordinates system type.

Reimplemented in OdGiContextForDbDatabase.

◆ database()

virtual OdDbBaseDatabase * OdGiContext::database ( ) const

pure virtual

Retrieves the database that is currently being vectorized.

Returns: pointer to the database being vectorized.

Implemented in OdGiContextForIfcDatabase, OdGiDummyContext< OdGiContext >, OdGiViewportDraw_Dummy, OdGiWorldDraw_Dummy, and OdGiContextForDbDatabase.

◆ defaultLineWeight()

virtual OdDb::LineWeight OdGiContext::defaultLineWeight ( ) const

virtual

Retrieves the default lineweight associated with this Context object.

Returns: the values from the OdDb::LineWeight enumeration that represent lineweight configurations.

Reimplemented in OdGiContextForDbDatabase.

◆ displayMeshSilhouettes()

bool OdGiContext::displayMeshSilhouettes ( ) const

inline

Checks whether generation of silhouettes is enabled for mesh primitives on Gi side.

Returns: true if generation of silhouettes is enabled for mesh primitives on Gi side, false otherwise.

Definition at line 721 of file GiCommonDraw.h.

◆ displayModelerSilhouettes()

bool OdGiContext::displayModelerSilhouettes ( ) const

inline

Checks whether generation of silhouettes is enabled for modeler geometry.

Returns: true if generation of silhouettes is enabled for modeler geometry.

Definition at line 728 of file GiCommonDraw.h.

◆ displaySilhouettes()

virtual OdUInt32 OdGiContext::displaySilhouettes ( ) const

virtual

Retrieves a silhouette type.

Returns: silhouette type as OdUInt32 value.

Reimplemented in OdGiContextForDbDatabase.

◆ drawableFilterFunction()

virtual OdUInt32 OdGiContext::drawableFilterFunction	(	OdIntPtr	functionId,
		const OdGiDrawable *	pDrawable,
		OdUInt32	nFlags
	)

virtual

Retrieves the set of flags for the drawable filtration function (will be called for each drawable vectorization).

Parameters

functionId	[in] Internal drawable filtration function ID.
pDrawable	[in] Currently vectorizing drawable pointer.
nFlags	[in] Set of input flags.

Returns: 0.

Reimplemented in OdGiContextForIfcDatabase, and OdGiContextForDbDatabase.

◆ drawableFilterFunctionId()

virtual OdIntPtr OdGiContext::drawableFilterFunctionId ( OdDbStub * viewportId ) const

virtual

Retrieves internal drawable filtration function ID. Must be implemented in derived classes.

Parameters

viewportId [in] Pointer to the Object ID of the Viewport object to be queried.

Returns: 0.

Reimplemented in OdGiContextForIfcDatabase, and OdGiContextForDbDatabase.

◆ drawShape() [1/2]

virtual void OdGiContext::drawShape	(	OdGiCommonDraw *	pDraw,
		OdGePoint3d &	position,
		int	shapeNumber,
		const OdGiTextStyle *	pTextStyle
	)

virtual

Vectorizes the specified shape to the specified interface object.

Parameters

pDraw	[in] Pointer to the CommonDraw object.
position	[in] Position of the shape.
shapeNumber	[in] Shape number.
pTextStyle	[in] Pointer to the TextStyle for the shape.

Reimplemented in OdGiDefaultContext.

◆ drawShape() [2/2]

virtual void OdGiContext::drawShape	(	OdGiConveyorGeometry *	pDest,
		const OdGePoint3d &	position,
		const OdGeVector3d &	direction,
		const OdGeVector3d &	upVector,
		int	shapeNumber,
		const OdGiTextStyle *	pTextStyle,
		const OdGeVector3d *	pExtrusion
	)

virtual

Vectorizes the specified shape.

Parameters

pDest	[in] Pointer to the Conveyor object.
position	[in] Position of a shape.
direction	[in] Baseline direction for the text.
upVector	[in] Up vector for the text.
shapeNumber	[in] Number of shape to draw. Shape is a single character of a special SHX font. This function returns the number of that character.
pTextStyle	[in] Pointer to the text style applied to a shape.
pExtrusion	[in] Pointer to the Extrusion vector for the text.

Reimplemented in OdGiDefaultContext.

◆ drawText() [1/3]

virtual void OdGiContext::drawText	(	OdGiCommonDraw *	pDraw,
		OdGePoint3d &	position,
		const OdChar *	msg,
		OdInt32	numBytes,
		const OdGiTextStyle *	pTextStyle,
		OdUInt32	flags = `0`
	)

virtual

Vectorizes the specified text string to the supplied CommonDraw object.

Parameters

pDraw	[in] Pointer to the CommonDraw object.
position	[in] Position of the text.
msg	[in] Text string.
numBytes	[in] Number of bytes in msg (not including the optional null byte).
pTextStyle	[in] Pointer to the TextStyle for msg.
flags	[in] Vectorization flags.

Remarks: msg must be null terminated if numBytes is not supplied.

Reimplemented in OdGiDefaultContext.

◆ drawText() [2/3]

virtual void OdGiContext::drawText	(	OdGiCommonDraw *	pDraw,
		OdGePoint3d &	position,
		double	height,
		double	width,
		double	oblique,
		const OdString &	msg
	)

virtual

Vectorizes the specified text string to the supplied CommonDraw object.

Parameters

pDraw	[in] Pointer to the CommonDraw object.
position	[in] Position of the text.
height	[in] Height of the text.
width	[in] Width of the text.
oblique	[in] Oblique angle of the text.
msg	[in] Text message.

Remarks: All angles are expressed in radians.

As currently implemented, this function ignores width and oblique. They will be fully implemented in a future release.

Reimplemented in OdGiDefaultContext.

◆ drawText() [3/3]

virtual void OdGiContext::drawText	(	OdGiConveyorGeometry *	pDest,
		const OdGePoint3d &	position,
		const OdGeVector3d &	direction,
		const OdGeVector3d &	upVector,
		const OdChar *	msg,
		OdInt32	numBytes,
		bool	raw,
		const OdGiTextStyle *	pTextStyle,
		const OdGeVector3d *	pExtrusion
	)

virtual

Vectorizes the specified text string to the supplied CommonDraw object.

Parameters

pDest	[in] Pointer to the Conveyor object.
position	[in] Position of the text.
direction	[in] Baseline direction for the text.
upVector	[in] Up vector for the text.
msg	[in] Text string.
numBytes	[in] Number of bytes in msg (not including the optional null byte).
raw	[in] If and only if true, escape sequences, such as %P, will not be converted to special characters.
pTextStyle	[in] Pointer to the TextStyle for msg.
pExtrusion	[in] Pointer to the extrusion vector for the text.

Reimplemented in OdGiDefaultContext.

◆ fadingIntensityPercentage()

virtual OdUInt32 OdGiContext::fadingIntensityPercentage ( FadingType fadingType ) const

virtual

Retrieves Fading intensity percentage.

Parameters

fadingType [in] Fading type.

Returns: 50 if fading type isn't kRefEditFade, 70 is returned otherwise.

Reimplemented in OdGiContextForDbDatabase.

◆ fillMode()

virtual bool OdGiContext::fillMode ( ) const

virtual

Checks whether shell/mesh geometry primitives should be filled during this vectorization.

Returns: true if shell/mesh geometry primitives should be filled, false otherwise.

Reimplemented in OdGiContextForDbDatabase.

◆ fillTtf()

virtual bool OdGiContext::fillTtf ( ) const

virtual

Checks whether TrueType text should be filled during this vectorization.

Returns: true if TrueType text should be filled during this vectorization, false otherwise.

Reimplemented in OdGiContextForDbDatabase.

◆ getDatabaseByStub()

virtual OdDbBaseDatabase * OdGiContext::getDatabaseByStub ( OdDbStub * objectId ) const

virtual

Retrieves the database of an Object ID.

Parameters

objectId [in] Object ID.

Returns: pointer to the database of the specified object identifier.

Reimplemented in OdGiDefaultContext.

◆ getDefaultTextStyle()

virtual void OdGiContext::getDefaultTextStyle ( OdGiTextStyle & textStyle )

virtual

Retrieves the default text style associated with this Context object.

Parameters

textStyle [out] Receives the TextStyle object.

Reimplemented in OdGiContextForDbDatabase, and OdGiDefaultContext.

◆ getIDByStub()

virtual OdUInt64 OdGiContext::getIDByStub ( OdDbStub * objectId ) const

virtual

Converts an Object ID to an object handle (database persistent ID).

Parameters

objectId [in] Object ID.

Reimplemented in OdGiDefaultContext.

◆ getOwnerIDByStub()

virtual OdDbStub * OdGiContext::getOwnerIDByStub ( OdDbStub * objectId ) const

virtual

Retrieves the Owner Object ID of the specified Object ID.

Parameters

objectId [in] Object ID.

Returns: pointer to the identifier of owner object.

Reimplemented in OdGiDefaultContext.

◆ getSectionGeometryManager()

virtual OdGiSectionGeometryManagerPtr OdGiContext::getSectionGeometryManager ( )

virtual

Retrieves the interface for accessing section geometry functionality.

Returns: smart pointer to the OdGiSectionGeometryManager instance.

Reimplemented in OdGiContextForDbDatabase.

◆ getStubByID()

virtual OdDbStub * OdGiContext::getStubByID ( OdUInt64 persistentId ) const

virtual

Converts an object handle into an Object ID.

Parameters

persistentId [in] Object handle.

Returns: converted object identifier.

Reimplemented in OdGiContextForDbDatabase, and OdGiDefaultContext.

◆ getStubByMaterialId()

virtual OdDbStub * OdGiContext::getStubByMaterialId	(	OdDbBaseDatabase *	pBaseDb,
		const OdUInt64 &	materialId
	)		const

virtual

Converts a material id into an Object ID. This method may check that converted Object ID is really material.

Parameters

pBaseDb	[in] Pointer to a database.
materialId	[in] Material identifier.

Returns: pointer to a converted object identifier.

Reimplemented in OdGiContextForDbDatabase.

◆ getStubByMatName()

virtual OdDbStub * OdGiContext::getStubByMatName	(	OdDbBaseDatabase *	pBaseDb,
		const OdString &	strMatName
	)		const

virtual

Converts a material name into an Object ID.

Parameters

pBaseDb	[in] Pointer to a database where to search for material name.
strMatName	[in] Material name.

Returns: pointer to the identifier of owner object.

Reimplemented in OdGiContextForDbDatabase.

◆ glyphSize()

virtual OdUInt32 OdGiContext::glyphSize ( GlyphType glyphType ) const

virtual

Retrieves the glyph size for the specified glyph type.

Parameters

glyphType [in] Type of glyph to return glyph size for.

Returns: Retrieves a value in the range [0,100].

The default return values are the following:

Value kLightGlyph 0 kCameraGlyph 50

◆ imageQuality()

virtual ImageQuality OdGiContext::imageQuality ( ) const

virtual

Retrieves the image quality for this vectorization process.

Returns: Image quality as a value of ImageQuality enumeration.

Reimplemented in OdGiContextForDbDatabase.

◆ imageSelectionBehavior()

virtual OdUInt32 OdGiContext::imageSelectionBehavior ( ) const

virtual

Retrieves a set of flags that describe image behavior during selection.

Returns: Set of ImageSelectionFlags enumeration bit flags.

Reimplemented in OdGiContextForDbDatabase.

◆ isPlotGeneration()

virtual bool OdGiContext::isPlotGeneration ( ) const

virtual

Checks whether this vectorization is intended for hard copy output.

Returns: true if this vectorization is intended for hard copy output, false otherwise.

Reimplemented in OdGiContextForIfcDatabase, and OdGiContextForDbDatabase.

◆ lineWeightConfiguration()

virtual OdUInt32 OdGiContext::lineWeightConfiguration ( LineWeightStyle styleEntry ) const

virtual

Retrieves the lineweight display style configuration.

Parameters

styleEntry [in] Lineweight style entry for which the current setting will be returned.

Returns

kPointLineWeight style, 0 will be returned if point lineweight is disabled or 1 will be returned if enabled. For kLineCapStyle style, entry will be returned as a member of the OdPs::LineEndStyle enumeration. For kLineJoinStyle style, entry will be returned as a member of the OdPs::LineJoinStyle enumeration.

See also: <link tv_working_with_attributes_lineweights, Work with Lineweights>

◆ multiplyByBlockLinetypeScales()

virtual bool OdGiContext::multiplyByBlockLinetypeScales ( ) const

virtual

Controls processing of line type scales.

◆ numberOfIsolines()

virtual OdUInt32 OdGiContext::numberOfIsolines ( ) const

virtual

Retrieves the number of isolines to be drawn on surfaces during this vectorization.

Returns: number of isolines as OdUInt32 value.

Reimplemented in OdGiContextForDbDatabase.

◆ ODRX_DECLARE_MEMBERS()

OdGiContext::ODRX_DECLARE_MEMBERS ( OdGiContext )

◆ openDrawable()

virtual OdGiDrawablePtr OdGiContext::openDrawable ( OdDbStub * drawableId )

pure virtual

Opens for reading the specified drawable object that belongs to the database associated with this Context object.

Parameters

drawableId [in] Object ID of the drawable to be opened.

Returns: Retrieves a SmartPointer to the drawable object.

Implemented in OdGiContextForIfcDatabase, OdGiContextForDbDatabase, and OdGiDummyContext< OdGiContext >.

◆ paletteBackground()

virtual ODCOLORREF OdGiContext::paletteBackground ( ) const

virtual

Retrieves the palette background color.

Returns: palette background color as ODCOLORREF definition.

Reimplemented in OdGiContextForIfcDatabase, OdGiContextForDbDatabase, and OdGiDefaultContext.

◆ plotStyle() [1/2]

virtual void OdGiContext::plotStyle	(	int	penNumber,
		OdPsPlotStyleData &	plotStyleData
	)		const

virtual

Retrieves the PaperSpace PlotStyle data for this vectorization.

Parameters

penNumber	[in] Pen number.
plotStyleData	[out] Receives the PlotStyle data.
objectId	[in] Object ID of plot style.

Reimplemented in OdGiContextForDbDatabase.

◆ plotStyle() [2/2]

virtual void OdGiContext::plotStyle	(	OdDbStub *	objectId,
		OdPsPlotStyleData &	plotStyleData
	)		const

virtual

Retrieves the PaperSpace PlotStyle data for this vectorization.

Parameters

objectId	[in] Object ID of plot style.
plotStyleData	[out] Receives the PlotStyle data.

Reimplemented in OdGiContextForDbDatabase.

◆ plotStyleType()

virtual PStyleType OdGiContext::plotStyleType ( ) const

virtual

Retrieves the plot style type of this Context object.

Returns: returns one of the following:

Value kPsNone 0 kPsByColor 1 kPsByName 2

Reimplemented in OdGiContextForDbDatabase.

◆ quickTextMode()

virtual bool OdGiContext::quickTextMode ( ) const

virtual

Retrieves true if and only if quick text mode is enabled for this vectorization process.

Returns: true if quick text mode is enabled for this vectorization process, false otherwise.

Reimplemented in OdGiContextForDbDatabase.

◆ regenAbort()

virtual bool OdGiContext::regenAbort ( ) const

virtual

Checks whether this vectorization process should be aborted.

Returns: true if this vectorization process should be aborted.

◆ selectionStyle()

virtual OdUInt32 OdGiContext::selectionStyle	(	OdUInt32	nStyle,
		OdGiSelectionStyle &	selStyle
	)		const

virtual

Retrieves the selection styles for entities highlighting.

Parameters

nStyle	[in] Selection style index.
selStyle	[out] Receives the selection style data.

Returns: Number of selection styles provided by this context object.

Remarks: This method should return at least single selection style for 0 index.

Reimplemented in OdGiContextForDbDatabase.

◆ shapeExtentsBox()

virtual void OdGiContext::shapeExtentsBox	(	const OdGiTextStyle &	textStyle,
		int	shapeNumber,
		OdGePoint3d &	min,
		OdGePoint3d &	max
	)

virtual

Retrieves the extents box for the specified shape.

Parameters

textStyle	[in] TextStyle for the shape.
shapeNumber	[in] Number of a shape. Shape is a single character of a special SHX font. This function returns the number of that character.
min	[out] Receives the lower-left corner of the extents box.
max	[out] Receives the upper-right corner of the extents box.

Reimplemented in OdGiDefaultContext.

◆ textExtentsBox()

virtual void OdGiContext::textExtentsBox	(	const OdGiTextStyle &	textStyle,
		const OdChar *	msg,
		int	nLength,
		OdUInt32	flags,
		OdGePoint3d &	min,
		OdGePoint3d &	max,
		OdGePoint3d *	pEndPos = `0`
	)

virtual

Retrieves the extents box for the specified text.

Parameters

textStyle	[in] TextStyle for msg.
msg	[in] Pointer to an array of characters.
nLength	[in] Message length.
flags	[in] Vectorization flags.
min	[out] Receives the lower-left corner of the extents box.
max	[out] Receives the upper-right corner of the extents box.
pEndPos	[out] If non-NULL, receives the end position of the text string.

Reimplemented in OdGiDefaultContext.

◆ textQuality()

virtual OdUInt32 OdGiContext::textQuality ( ) const

virtual

Retrieves the text quality percent for this vectorization process.

Returns: value in the range [0,100]. 50 is the default.

See also: <link gi_ttf_render_quality, Adjusting the Quality of TrueType Font Text>

Reimplemented in OdGiContextForDbDatabase.

◆ ttfPolyDraw()

virtual bool OdGiContext::ttfPolyDraw ( ) const

virtual

Checks whether smooth contours information output is used for TrueType fonts.

Returns: true if smooth contours information output is used for TrueType fonts (OdCharacterProperties::kBezierCurves flag), false otherwise.

See also: <link gi_ttf_render_quality, Adjusting the Quality of TrueType Font Text>

Reimplemented in OdGiContextForDbDatabase.

◆ useTtfTriangleCache()

virtual bool OdGiContext::useTtfTriangleCache ( ) const

virtual

Retrieves true if and only if triangle cache for ttf fonts is enabled for this vectorization process.

Returns: true if triangle cache for ttf fonts is enabled for this vectorization process.

Reimplemented in OdGiContextForDbDatabase.

◆ xrefPropertiesOverride()

virtual bool OdGiContext::xrefPropertiesOverride ( ) const

virtual

Controls overriding of Xref properties.

Reimplemented in OdGiContextForDbDatabase.

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

GiCommonDraw.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ CoordinatesSystem

◆ DrawableFilterInputFlags

◆ DrawableFilterOutputFlags

◆ DrawableFilterRanges

◆ FadingType

◆ GlyphType

◆ ImageQuality

◆ ImageSelectionFlags

◆ LineWeightStyle

◆ PStyleType

◆ SilhouetteType

Member Function Documentation

◆ antiAliasingMode()

◆ circleZoomPercent()

◆ commonLinetypeScale()

◆ customViewportGeometryCS()

◆ database()

◆ defaultLineWeight()

◆ displayMeshSilhouettes()

◆ displayModelerSilhouettes()

◆ displaySilhouettes()

◆ drawableFilterFunction()

◆ drawableFilterFunctionId()

◆ drawShape() [1/2]

◆ drawShape() [2/2]

◆ drawText() [1/3]

◆ drawText() [2/3]

◆ drawText() [3/3]

◆ fadingIntensityPercentage()

◆ fillMode()

◆ fillTtf()

◆ getDatabaseByStub()

◆ getDefaultTextStyle()

◆ getIDByStub()

◆ getOwnerIDByStub()

◆ getSectionGeometryManager()

◆ getStubByID()

◆ getStubByMaterialId()

◆ getStubByMatName()

◆ glyphSize()

◆ imageQuality()

◆ imageSelectionBehavior()

◆ isPlotGeneration()

◆ lineWeightConfiguration()

◆ multiplyByBlockLinetypeScales()

◆ numberOfIsolines()

◆ ODRX_DECLARE_MEMBERS()

◆ openDrawable()

◆ paletteBackground()

◆ plotStyle() [1/2]

◆ plotStyle() [2/2]

◆ plotStyleType()

◆ quickTextMode()

◆ regenAbort()

◆ selectionStyle()

◆ shapeExtentsBox()

◆ textExtentsBox()

◆ textQuality()

◆ ttfPolyDraw()

◆ useTtfTriangleCache()

◆ xrefPropertiesOverride()