CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
OdGiDefaultContext Class Referenceabstract

#include <GiDefaultContext.h>

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

Public Types

enum  SolidHatchAsPolygonMode { kHatchTriangulation , kHatchPolygon , kHatchBoth }
 
- Public Types inherited from OdGiContext
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 (OdGiDefaultContext)
 
 OdGiDefaultContext ()
 
 ~OdGiDefaultContext ()
 
virtual void getDefaultTextStyle (OdGiTextStyle &textStyle)
 
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 void setPlotGeneration (bool plotGeneration)=0
 
virtual ODCOLORREF paletteBackground () const =0
 
virtual void setPaletteBackground (ODCOLORREF paletteBackground)=0
 
virtual bool isZeroTextNormals () const
 
virtual bool supportVerticalTTFText () const
 
virtual bool useGsModel () const
 
virtual void enableGsModel (bool enable)
 
virtual SolidHatchAsPolygonMode hatchAsPolygon () const
 
virtual void setHatchAsPolygon (SolidHatchAsPolygonMode mode)
 
virtual OdDbStub * getStubByID (OdUInt64 persistentId) 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 OdDbBaseDatabasedatabase () 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 OdDbBaseDatabasegetDatabaseByStub (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 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
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 

Detailed Description

This class defines the default context that is used in the ODA Platform vectorization of OdDbDatabase instances.

Corresponding C++ library: TD_DbRoot

<group OdDbRoot_Classes>

Definition at line 39 of file GiDefaultContext.h.

Member Enumeration Documentation

◆ SolidHatchAsPolygonMode

Enumerator
kHatchTriangulation 
kHatchPolygon 
kHatchBoth 

Definition at line 128 of file GiDefaultContext.h.

Constructor & Destructor Documentation

◆ OdGiDefaultContext()

OdGiDefaultContext::OdGiDefaultContext ( )

◆ ~OdGiDefaultContext()

OdGiDefaultContext::~OdGiDefaultContext ( )

Member Function Documentation

◆ drawShape() [1/2]

virtual void OdGiDefaultContext::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 from OdGiContext.

◆ drawShape() [2/2]

void OdGiDefaultContext::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 from OdGiContext.

◆ drawText() [1/3]

virtual void OdGiDefaultContext::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 from OdGiContext.

◆ drawText() [2/3]

virtual void OdGiDefaultContext::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 from OdGiContext.

◆ drawText() [3/3]

virtual void OdGiDefaultContext::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 from OdGiContext.

◆ enableGsModel()

virtual void OdGiDefaultContext::enableGsModel ( bool  enable)
virtual

Controls the GsModel flag of this Context Object.

Parameters
enable[in] Controls the Gs Model.

Reimplemented in OdGiContextForIfcDatabase, and OdGiContextForDbDatabase.

◆ getDatabaseByStub()

virtual OdDbBaseDatabase * OdGiDefaultContext::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 from OdGiContext.

◆ getDefaultTextStyle()

virtual void OdGiDefaultContext::getDefaultTextStyle ( OdGiTextStyle textStyle)
virtual

Retrieves the default text style associated with this Context object.

Parameters
textStyle[out] Receives the TextStyle object.

Reimplemented from OdGiContext.

Reimplemented in OdGiContextForDbDatabase.

◆ getIDByStub()

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

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

Parameters
objectId[in] Object ID.

Reimplemented from OdGiContext.

◆ getOwnerIDByStub()

virtual OdDbStub * OdGiDefaultContext::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 from OdGiContext.

◆ getStubByID()

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

Converts an object handle into an Object ID.

Parameters
persistentId[in] Object handle.
Returns
converted object identifier.

Reimplemented from OdGiContext.

Reimplemented in OdGiContextForDbDatabase.

◆ hatchAsPolygon()

virtual SolidHatchAsPolygonMode OdGiDefaultContext::hatchAsPolygon ( ) const
inlinevirtual

Reimplemented in OdGiContextForDbDatabase.

Definition at line 135 of file GiDefaultContext.h.

◆ isZeroTextNormals()

virtual bool OdGiDefaultContext::isZeroTextNormals ( ) const
inlinevirtual

Reimplemented in OdGiContextForDbDatabase.

Definition at line 113 of file GiDefaultContext.h.

◆ ODRX_DECLARE_MEMBERS()

OdGiDefaultContext::ODRX_DECLARE_MEMBERS ( OdGiDefaultContext  )

◆ paletteBackground()

virtual ODCOLORREF OdGiDefaultContext::paletteBackground ( ) const
pure virtual

Retrieves the palette background color.

Returns
palette background color as ODCOLORREF definition.

Reimplemented from OdGiContext.

Implemented in OdGiContextForIfcDatabase, and OdGiContextForDbDatabase.

◆ setHatchAsPolygon()

virtual void OdGiDefaultContext::setHatchAsPolygon ( SolidHatchAsPolygonMode  mode)
virtual

Reimplemented in OdGiContextForDbDatabase.

◆ setPaletteBackground()

virtual void OdGiDefaultContext::setPaletteBackground ( ODCOLORREF  paletteBackground)
pure virtual

◆ setPlotGeneration()

virtual void OdGiDefaultContext::setPlotGeneration ( bool  plotGeneration)
pure virtual

◆ shapeExtentsBox()

virtual void OdGiDefaultContext::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 from OdGiContext.

◆ supportVerticalTTFText()

virtual bool OdGiDefaultContext::supportVerticalTTFText ( ) const
inlinevirtual

Definition at line 115 of file GiDefaultContext.h.

◆ textExtentsBox()

virtual void OdGiDefaultContext::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 from OdGiContext.

◆ useGsModel()

virtual bool OdGiDefaultContext::useGsModel ( ) const
inlinevirtual

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

Reimplemented in OdGiContextForIfcDatabase, and OdGiContextForDbDatabase.

Definition at line 120 of file GiDefaultContext.h.


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