CFx SDK Documentation  2023 SP0
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
OdGiContextForDbDatabase Class Reference

#include <GiContextForDbDatabase.h>

Inheritance diagram for OdGiContextForDbDatabase:
OdGiDefaultContext OdGiContext OdRxObject AECGe::Harvester AECGe::HarvesterOverall

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiContextForDbDatabase)
 
 ~OdGiContextForDbDatabase ()
 
virtual OdDbBaseDatabasedatabase () const
 
virtual OdGiDrawablePtr openDrawable (OdDbStub *drawableId)
 
virtual OdUInt32 numberOfIsolines () const
 
virtual double commonLinetypeScale () const
 
virtual OdDb::LineWeight defaultLineWeight () const
 
virtual bool quickTextMode () const
 
virtual OdUInt32 textQuality () const
 
virtual ImageQuality imageQuality () const
 
virtual OdUInt32 fadingIntensityPercentage (FadingType fadingType) const
 
virtual bool ttfPolyDraw () const
 
virtual OdUInt32 displaySilhouettes () const
 
void setDatabase (OdDbDatabase *pDb, bool bTrackDbDestroy=true)
 
OdDbDatabasegetDatabase () const
 
virtual void fillGsClientViewInfo (const OdDbObjectId &vpId, OdGsClientViewInfo &viewInfo)
 
virtual OdDbStub * getStubByID (OdUInt64 objectId) const
 
virtual OdDbStub * getStubByMatName (const OdString &strMatName) const
 
virtual void getDefaultTextStyle (OdGiTextStyle &textStyle)
 
unsigned int circleZoomPercent (OdDbStub *viewportId) const
 
virtual OdIntPtr drawableFilterFunctionId (OdDbStub *viewportId) const
 
virtual OdUInt32 drawableFilterFunction (OdIntPtr functionId, const OdGiDrawable *pDrawable, OdUInt32 nFlags)
 
bool useGsModel () const
 
void enableGsModel (bool enable)
 
bool isPlotGeneration () const
 
void setPlotGeneration (bool plotGeneration)
 
virtual bool isZeroTextNormals () const
 
void setZeroTextNormals (bool bZeroTextNormals)
 
bool isLayoutHelperLinkReactorsDisabled () const
 
void disableLayoutHelperLinkReactors (bool bDisableLinkReactors)
 
bool isContextualColorsManagementEnabled () const
 
void enableContextualColorsManagement (bool bEnable)
 
virtual void updateContextualColors (OdGsView *pView)
 
virtual void fillContextualColors (OdGiContextualColorsImpl *pCtxColors)
 
void setTtfPolyDrawMode (bool bPolyDraw)
 
bool isKeepPSLayoutHelperViewEnabled () const
 
void enableKeepPSLayoutHelperView (bool bEnable)
 
bool erasePSLayoutHelperView () const
 
void setErasePSLayoutHelperView (bool bOn)
 
bool isConstantModelSpaceLineweightsEnabled () const
 
void enableConstantModelSpaceLineweights (bool bEnable)
 
bool isForceDisplaySilhouettesEnabled () const
 
void setForceDisplaySilhouettes (bool bOn)
 
bool fillTtf () const
 
bool fillMode () const
 
ODCOLORREF paletteBackground () const
 
void setPaletteBackground (ODCOLORREF paletteBackground)
 
void loadPlotStyleTable (OdStreamBuf *pStreamBuf)
 
virtual PStyleType plotStyleType () const
 
virtual void plotStyle (int penNumber, OdPsPlotStyleData &plotStyleData) const
 
virtual void plotStyle (OdDbStub *psNameId, OdPsPlotStyleData &plotStyleData) const
 
virtual OdGiSectionGeometryManagerPtr getSectionGeometryManager ()
 
virtual OdUInt32 antiAliasingMode () const
 
virtual bool xrefPropertiesOverride () const
 
SolidHatchAsPolygonMode hatchAsPolygon () const
 
void setHatchAsPolygon (SolidHatchAsPolygonMode mode)
 
- Public Member Functions inherited from OdGiDefaultContext
 ODRX_DECLARE_MEMBERS (OdGiDefaultContext)
 
 OdGiDefaultContext ()
 
 ~OdGiDefaultContext ()
 
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 nLength, bool raw, const OdGiTextStyle *pTextStyle, const OdGeVector3d *pExtrusion)
 
virtual void drawShape (OdGiCommonDraw *pDraw, OdGePoint3d &position, int shapeNumber, const OdGiTextStyle *pTextStyle)
 
void drawShape (OdGiConveyorGeometry *pDest, const OdGePoint3d &position, const OdGeVector3d &direction, const OdGeVector3d &upVector, int shapeNumber, 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 bool supportVerticalTTFText () const
 
virtual OdUInt64 getIDByStub (OdDbStub *objectId) const
 
virtual OdDbBaseDatabasegetDatabaseByStub (OdDbStub *objectId) const
 
virtual OdDbStub * getOwnerIDByStub (OdDbStub *objectId) const
 
- Public Member Functions inherited from OdGiContext
 ODRX_DECLARE_MEMBERS (OdGiContext)
 
virtual OdUInt32 glyphSize (GlyphType glyphType) const
 
virtual OdUInt32 lineWeightConfiguration (LineWeightStyle styleEntry) const
 
virtual bool regenAbort () const
 
bool displayMeshSilhouettes () const
 
bool displayModelerSilhouettes () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Protected Member Functions

 OdGiContextForDbDatabase ()
 

Protected Attributes

ODCOLORREF m_paletteBackground
 
OdPsPlotStyleTablePtr m_pPlotStyleTable
 

Additional Inherited Members

- Public Types inherited from OdGiDefaultContext
enum  SolidHatchAsPolygonMode { kHatchTriangulation , kHatchPolygon , kHatchBoth }
 
- Public Types inherited from OdGiContext
enum  ImageQuality { kImageQualityDraft = 0 , kImageQualityHigh = 1 }
 
enum  FadingType { kLockedLayerFade = 0 , kXrefFade = 1 , kRefEditFade = 2 }
 
enum  GlyphType { kLightGlyph = 0 , kCameraGlyph = 1 }
 
enum  LineWeightStyle { kPointLineWeight = 0 , kLineCapStyle = 1 , kLineJoinStyle = 2 }
 
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 }
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class defines the operations and properties that are used in the Teigha vectorization of an OdDbDatabase.

Corresponding C++ library: TD_Db

<group OdDb_Classes>

Definition at line 51 of file GiContextForDbDatabase.h.

Constructor & Destructor Documentation

◆ OdGiContextForDbDatabase()

OdGiContextForDbDatabase::OdGiContextForDbDatabase ( )
protected

◆ ~OdGiContextForDbDatabase()

OdGiContextForDbDatabase::~OdGiContextForDbDatabase ( )

Member Function Documentation

◆ antiAliasingMode()

virtual OdUInt32 OdGiContextForDbDatabase::antiAliasingMode ( ) const
virtual

Controls rendering anti-aliasing.

Reimplemented from OdGiContext.

◆ circleZoomPercent()

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

Returns the circle zoom percent for this vectorization process.

Parameters
viewportId[in] Pointer to the Object ID of the Viewport object to be queried.
Returns
Returns a value in the range [1,20000]. 100 is the default.

Reimplemented from OdGiContext.

◆ commonLinetypeScale()

virtual double OdGiContextForDbDatabase::commonLinetypeScale ( ) const
virtual

Returns the common linetype scale for this Context object.

Reimplemented from OdGiContext.

◆ database()

virtual OdDbBaseDatabase* OdGiContextForDbDatabase::database ( ) const
virtual

Returns the database that is currently being vectorized.

Implements OdGiContext.

◆ defaultLineWeight()

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

Returns the default lineweight associated with this Context object.

Reimplemented from OdGiContext.

◆ disableLayoutHelperLinkReactors()

void OdGiContextForDbDatabase::disableLayoutHelperLinkReactors ( bool  bDisableLinkReactors)

Controls the kDisableLayoutHelperLinkReactors flag of this Context Object.

Parameters
bDisableLinkReactors[in] Controls layout link reactors flag.

◆ displaySilhouettes()

virtual OdUInt32 OdGiContextForDbDatabase::displaySilhouettes ( ) const
virtual

Controls the display of silhouettes.

Reimplemented from OdGiContext.

◆ drawableFilterFunction()

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

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

Reimplemented from OdGiContext.

◆ drawableFilterFunctionId()

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

Returns internal drawable filtration function ID.

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

Reimplemented from OdGiContext.

◆ enableConstantModelSpaceLineweights()

void OdGiContextForDbDatabase::enableConstantModelSpaceLineweights ( bool  bEnable)

Controls behavior of ModelSpace lineweights.

Parameters
bEnable[in] Enable contant ModelSpace lineweights.

◆ enableContextualColorsManagement()

void OdGiContextForDbDatabase::enableContextualColorsManagement ( bool  bEnable)

Controls the kManageContextualColors flag of this Context Object.

Parameters
bEnable[in] Controls contextual colors management flag.

◆ enableGsModel()

void OdGiContextForDbDatabase::enableGsModel ( bool  enable)
virtual

Controls the GsModel flag of this Context Object.

Parameters
enable[in] Controls the Gs Model.

Reimplemented from OdGiDefaultContext.

◆ enableKeepPSLayoutHelperView()

void OdGiContextForDbDatabase::enableKeepPSLayoutHelperView ( bool  bEnable)

Controls the kKeepPSLayoutHelperView flag of this Context Object.

Parameters
bEnable[in] Controls PaperSpace layout helper view management flag.

◆ erasePSLayoutHelperView()

bool OdGiContextForDbDatabase::erasePSLayoutHelperView ( ) const

Returns true if and only if the kErasePSLayoutHelperView flag of this Context Object is set.

◆ fadingIntensityPercentage()

virtual OdUInt32 OdGiContextForDbDatabase::fadingIntensityPercentage ( FadingType  fadingType) const
virtual

Fading intensity percentage.

Reimplemented from OdGiContext.

◆ fillContextualColors()

virtual void OdGiContextForDbDatabase::fillContextualColors ( OdGiContextualColorsImpl pCtxColors)
virtual

Initialize contextual colors container by contextual colors values.

Parameters
pCtxColors[in] Pointer to contextual colors container.

◆ fillGsClientViewInfo()

virtual void OdGiContextForDbDatabase::fillGsClientViewInfo ( const OdDbObjectId vpId,
OdGsClientViewInfo viewInfo 
)
virtual

Returns the OdGsClientViewInfo for the specified viewport.

Parameters
vpId[in] Object ID of the viewport.
viewInfo[out] Receives the client view info.

◆ fillMode()

bool OdGiContextForDbDatabase::fillMode ( ) const
virtual

Returns true if and only if shell/mesh geometry primitives should be filled during this vectorization.

Reimplemented from OdGiContext.

◆ fillTtf()

bool OdGiContextForDbDatabase::fillTtf ( ) const
virtual

Returns true if and only if filling of TrueType fonts is enabled.

Reimplemented from OdGiContext.

◆ getDatabase()

OdDbDatabase* OdGiContextForDbDatabase::getDatabase ( ) const

Returns the database that is currently being vectorized.

◆ getDefaultTextStyle()

virtual void OdGiContextForDbDatabase::getDefaultTextStyle ( OdGiTextStyle textStyle)
virtual

Returns the default text style associated with this Context object.

Parameters
textStyle[out] Receives the TextStyle object.

Reimplemented from OdGiDefaultContext.

◆ getSectionGeometryManager()

virtual OdGiSectionGeometryManagerPtr OdGiContextForDbDatabase::getSectionGeometryManager ( )
virtual

Returns an interface for access section geometry functionality.

Reimplemented from OdGiContext.

◆ getStubByID()

virtual OdDbStub* OdGiContextForDbDatabase::getStubByID ( OdUInt64  objectId) const
virtual

Returns the OdDbStub for the specified handle id.

Parameters
objectId[in] Object ID of the object. Returns the pointer to OdDbStub.

Reimplemented from OdGiDefaultContext.

◆ getStubByMatName()

virtual OdDbStub* OdGiContextForDbDatabase::getStubByMatName ( const OdString strMatName) const
virtual

Converts a material name into an Object ID.

Parameters
strMatName[in] Material name.

Reimplemented from OdGiContext.

◆ hatchAsPolygon()

SolidHatchAsPolygonMode OdGiContextForDbDatabase::hatchAsPolygon ( ) const
virtual

Returns SolidHatchAsPolygonMode set for this Context Object.

Reimplemented from OdGiDefaultContext.

◆ imageQuality()

virtual ImageQuality OdGiContextForDbDatabase::imageQuality ( ) const
virtual

Returns the image quality for this vectorization process.

Reimplemented from OdGiContext.

◆ isConstantModelSpaceLineweightsEnabled()

bool OdGiContextForDbDatabase::isConstantModelSpaceLineweightsEnabled ( ) const

Returns current behavior of ModelSpace lineweights.

◆ isContextualColorsManagementEnabled()

bool OdGiContextForDbDatabase::isContextualColorsManagementEnabled ( ) const

Returns true if and only the kManageContextualColors flag of this Context Object is set.

◆ isForceDisplaySilhouettesEnabled()

bool OdGiContextForDbDatabase::isForceDisplaySilhouettesEnabled ( ) const

Returns current state of display silhouettes forcing mode.

◆ isKeepPSLayoutHelperViewEnabled()

bool OdGiContextForDbDatabase::isKeepPSLayoutHelperViewEnabled ( ) const

Returns true if and only if the kKeepPSLayoutHelperView flag of this Context Object is set.

◆ isLayoutHelperLinkReactorsDisabled()

bool OdGiContextForDbDatabase::isLayoutHelperLinkReactorsDisabled ( ) const

Returns true if and only the kDisableLayoutHelperLinkReactors flag of this Context Object is set.

◆ isPlotGeneration()

bool OdGiContextForDbDatabase::isPlotGeneration ( ) const
virtual

Returns true if and only the PlotGeneration flag of this Context Object is set.

Reimplemented from OdGiContext.

◆ isZeroTextNormals()

virtual bool OdGiContextForDbDatabase::isZeroTextNormals ( ) const
virtual

Returns true if and only the kOdGiZeroTextNormals flag of this Context Object is set.

Reimplemented from OdGiDefaultContext.

◆ loadPlotStyleTable()

void OdGiContextForDbDatabase::loadPlotStyleTable ( OdStreamBuf pStreamBuf)

Loads the specified plot style table for this Context object.

Parameters
pStreamBuf[in] Pointer to the StreamBuf object from which the data are to be read.

◆ numberOfIsolines()

virtual OdUInt32 OdGiContextForDbDatabase::numberOfIsolines ( ) const
virtual

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

Reimplemented from OdGiContext.

◆ ODRX_DECLARE_MEMBERS()

OdGiContextForDbDatabase::ODRX_DECLARE_MEMBERS ( OdGiContextForDbDatabase  )

◆ openDrawable()

virtual OdGiDrawablePtr OdGiContextForDbDatabase::openDrawable ( OdDbStub *  drawableId)
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
Returns a SmartPointer to the drawable object.

Implements OdGiContext.

◆ paletteBackground()

ODCOLORREF OdGiContextForDbDatabase::paletteBackground ( ) const
inlinevirtual

Returns the palette background color for this Context object.

Implements OdGiDefaultContext.

Definition at line 283 of file GiContextForDbDatabase.h.

◆ plotStyle() [1/2]

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

Returns the plot style data for the specified pen number.

Parameters
penNumber[in] Pen number.
plotStyleData[out] Receives the plot style data.

Reimplemented from OdGiContext.

◆ plotStyle() [2/2]

virtual void OdGiContextForDbDatabase::plotStyle ( OdDbStub *  psNameId,
OdPsPlotStyleData plotStyleData 
) const
virtual

Returns the plot style data for the specified object Id.

Parameters
psNameId[in] Object id of the plot style name.
plotStyleData[out] Receives the plot style data.

Reimplemented from OdGiContext.

◆ plotStyleType()

virtual PStyleType OdGiContextForDbDatabase::plotStyleType ( ) const
virtual

Returns the plot style type for this Context object.

Reimplemented from OdGiContext.

◆ quickTextMode()

virtual bool OdGiContextForDbDatabase::quickTextMode ( ) const
virtual

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

Reimplemented from OdGiContext.

◆ setDatabase()

void OdGiContextForDbDatabase::setDatabase ( OdDbDatabase pDb,
bool  bTrackDbDestroy = true 
)

Sets the database to be vectorized.

Parameters
pDb[in] Pointer to the database.
bTrackDbDestroy[in] if to the database is not NULL then this parameter specifies if implementation should track database lifetime (by adding reactor to the database and processing OdDbDatabaseReactor::goodbye() event) and to clear pointer to the database if it will be destroyed. If you sure that lifetime of this object is shorter then lifetime of the database you may set this parameter to false to turn off unnecessary database lifetime tracking.

◆ setErasePSLayoutHelperView()

void OdGiContextForDbDatabase::setErasePSLayoutHelperView ( bool  bOn)

Controls the kErasePSLayoutHelperView flag of this Context Object.

Parameters
bEnable[in] Controls PaperSpace layout helper view management flag.

◆ setForceDisplaySilhouettes()

void OdGiContextForDbDatabase::setForceDisplaySilhouettes ( bool  bOn)

Sets current state of display silhouettes forcing mode.

Parameters
bOn[in] Enable or disable display silhouettes forcing.

◆ setHatchAsPolygon()

void OdGiContextForDbDatabase::setHatchAsPolygon ( SolidHatchAsPolygonMode  mode)
virtual

Controls SolidHatchAsPolygonMode of this Context Object.

Parameters
bOn[in] Controls hatch as polygon generation.

Reimplemented from OdGiDefaultContext.

◆ setPaletteBackground()

void OdGiContextForDbDatabase::setPaletteBackground ( ODCOLORREF  paletteBackground)
inlinevirtual

Sets the palette background color for this Context object.

Parameters
paletteBackground[in] Palette background.

Implements OdGiDefaultContext.

Definition at line 288 of file GiContextForDbDatabase.h.

◆ setPlotGeneration()

void OdGiContextForDbDatabase::setPlotGeneration ( bool  plotGeneration)
virtual

Controls the PlotGeneration flag of this Context Object.

Parameters
plotGeneration[in] Controls plot generation.

Implements OdGiDefaultContext.

◆ setTtfPolyDrawMode()

void OdGiContextForDbDatabase::setTtfPolyDrawMode ( bool  bPolyDraw)

Enables TrueType text contours info output.

Parameters
bPolyDraw[in] Controls kTTFPolyDraw flag of this Context Object.

◆ setZeroTextNormals()

void OdGiContextForDbDatabase::setZeroTextNormals ( bool  bZeroTextNormals)

Controls the ZeroTextNormals flag of this Context Object.

Parameters
bZeroTextNormals[in] Controls text normals generation.

◆ textQuality()

virtual OdUInt32 OdGiContextForDbDatabase::textQuality ( ) const
virtual

Returns the text quality percent for this vectorization process.

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

Reimplemented from OdGiContext.

◆ ttfPolyDraw()

virtual bool OdGiContextForDbDatabase::ttfPolyDraw ( ) const
virtual

Enables smooth contours information output for TrueType fonts.

Reimplemented from OdGiContext.

◆ updateContextualColors()

virtual void OdGiContextForDbDatabase::updateContextualColors ( OdGsView pView)
virtual

Update view contextual colors after view changes.

Parameters
pView[in] View pointer for update contextual colors.

◆ useGsModel()

bool OdGiContextForDbDatabase::useGsModel ( ) const
virtual

Returns true if and only the GsModel flag of this Context Object is set..

Reimplemented from OdGiDefaultContext.

◆ xrefPropertiesOverride()

virtual bool OdGiContextForDbDatabase::xrefPropertiesOverride ( ) const
virtual

Controls Xref properties overriding.

Reimplemented from OdGiContext.

Member Data Documentation

◆ m_paletteBackground

ODCOLORREF OdGiContextForDbDatabase::m_paletteBackground
protected

Definition at line 87 of file GiContextForDbDatabase.h.

◆ m_pPlotStyleTable

OdPsPlotStyleTablePtr OdGiContextForDbDatabase::m_pPlotStyleTable
protected

Definition at line 88 of file GiContextForDbDatabase.h.


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