CFx SDK Documentation  2020SP3
Public Member Functions | Protected Attributes | List of all members
OdGiContextForIfcDatabase Class Reference

#include <IfcGiContext.h>

Inheritance diagram for OdGiContextForIfcDatabase:
OdGiDefaultContext OdGiContext OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiContextForIfcDatabase)
 
 OdGiContextForIfcDatabase ()
 
 ~OdGiContextForIfcDatabase ()
 
virtual OdDbBaseDatabasedatabase () const
 
virtual bool isPlotGeneration () const
 
virtual void setPlotGeneration (bool plotGeneration)
 
virtual void setPaletteBackground (ODCOLORREF paletteBackground)
 
virtual OdGiDrawablePtr openDrawable (OdDbStub *drawableId)
 
virtual ODCOLORREF paletteBackground () const
 
void setDatabase (OdIfc::OdIfcFilePtr pIfcFile)
 
OdIfc::OdIfcFilegetDatabase () const
 
virtual void fillGsClientViewInfo (OdGsClientViewInfo &viewInfo)
 
virtual OdIntPtr drawableFilterFunctionId (OdDbStub *viewportId) const
 
virtual OdUInt32 drawableFilterFunction (OdIntPtr functionId, const OdGiDrawable *pDrawable, OdUInt32 nFlags)
 
bool useGsModel () const
 
void enableGsModel (bool enable)
 
void setRepresentationContext (OdDAIObjectId idRC)
 
OdDAIObjectId getRepresentationContext ()
 
- Public Member Functions inherited from OdGiDefaultContext
 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 bool isZeroTextNormals () const
 
virtual bool supportVerticalTTFText () const
 
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 OdDb::LineWeight defaultLineWeight () const
 
virtual double commonLinetypeScale () const
 
virtual unsigned int circleZoomPercent (OdDbStub *viewportId) const
 
virtual bool fillTtf () const
 
virtual OdUInt32 numberOfIsolines () const
 
virtual bool fillMode () const
 
virtual bool quickTextMode () const
 
virtual OdUInt32 textQuality () const
 
virtual ImageQuality imageQuality () const
 
virtual OdUInt32 fadingIntensityPercentage (FadingType fadingType) const
 
virtual OdUInt32 glyphSize (GlyphType glyphType) const
 
virtual OdUInt32 lineWeightConfiguration (LineWeightStyle styleEntry) const
 
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 * getStubByMatName (const OdString &strMatName) const
 
virtual OdUInt32 displaySilhouettes () const
 
bool displayMeshSilhouettes () const
 
bool displayModelerSilhouettes () const
 
virtual OdGiSectionGeometryManagerPtr getSectionGeometryManager ()
 
virtual OdUInt32 antiAliasingMode () const
 
virtual bool xrefPropertiesOverride () 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 Attributes

ODCOLORREF m_paletteBackground
 

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

A class that implements working with a vectorization context for an IFC database.

Definition at line 46 of file IfcGiContext.h.

Constructor & Destructor Documentation

◆ OdGiContextForIfcDatabase()

OdGiContextForIfcDatabase::OdGiContextForIfcDatabase ( )
inline

Creates a new Gi context instance for an IFC database with default parameters.

Remarks
By default, all flags are off and the palette background color is equal to black.

Definition at line 82 of file IfcGiContext.h.

◆ ~OdGiContextForIfcDatabase()

OdGiContextForIfcDatabase::~OdGiContextForIfcDatabase ( )
inline

Destroys the Gi context object.

Definition at line 87 of file IfcGiContext.h.

Member Function Documentation

◆ database()

virtual OdDbBaseDatabase* OdGiContextForIfcDatabase::database ( ) const
virtual

Retrieves an IFC database that is currently associated with the Gi context object.

Returns
Returns a raw pointer to the database that is currently being vectorized. Returns the IFC database that is currently being vectorized, represented as a pointer to an OdDbBaseDatabase object.

Implements OdGiContext.

◆ drawableFilterFunction()

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

Sets a new drawable filtration function and its parameters.

Parameters
functionId[in] An identifier of the new internal drawable filtration function.
pDrawable[in] A raw pointer to the currently vectorized drawable.
nFlags[in] A set of input flags for the filtration function.
Returns
Returns the resulting code of the operation.
Remarks
The drawable filtration function is called for each time when the drawable vectorization is needed.

Reimplemented from OdGiContext.

◆ drawableFilterFunctionId()

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

Retrieves the identifier of the current internal drawable filtration function.

Parameters
viewportId[in] A raw pointer to the object identifier of the viewport object to be returned.
Returns
Returns a raw pointer to the drawable filter function identifier value.

Reimplemented from OdGiContext.

◆ enableGsModel()

void OdGiContextForIfcDatabase::enableGsModel ( bool  enable)
virtual

Description: Sets a new value of the used Gs model flag.

Parameters
enable[in] A new flag value to be set.
Remarks
The used Gs model flag determines whether the Gs model is used for the vectorization process (if equal to true) or not (if equal to false).

Reimplemented from OdGiDefaultContext.

◆ fillGsClientViewInfo()

virtual void OdGiContextForIfcDatabase::fillGsClientViewInfo ( OdGsClientViewInfo viewInfo)
virtual

Retrieves the current information about the Gs client view object.

Parameters
viewInfo[out] A placeholder for the client view information.
Remarks
The method accepts an instance of the Gs client viewport information object, fills it with data from the context and returns it to a calling subroutine.

◆ getDatabase()

OdIfc::OdIfcFile* OdGiContextForIfcDatabase::getDatabase ( ) const

Retrieves the IFC database that is currently being vectorized.

Returns
Returns a raw pointer to the <link OdIfc::OdIfcFile, OdIfcFile> object that represents the currently vectorized IFC database.

◆ getRepresentationContext()

OdDAIObjectId OdGiContextForIfcDatabase::getRepresentationContext ( )

Retrieves the current representation context.

Returns
Returns the identifier of the current representation context object.

◆ isPlotGeneration()

virtual bool OdGiContextForIfcDatabase::isPlotGeneration ( ) const
virtual

Retrieves the current value of the plot generation flag.

Returns
Returns true if the vectorization is intended for hard copy output; otherwise, the method returns false.

Reimplemented from OdGiContext.

◆ ODRX_DECLARE_MEMBERS()

OdGiContextForIfcDatabase::ODRX_DECLARE_MEMBERS ( OdGiContextForIfcDatabase  )

◆ openDrawable()

virtual OdGiDrawablePtr OdGiContextForIfcDatabase::openDrawable ( OdDbStub *  drawableId)
virtual

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

Parameters
drawableId[in] An object's identifier of the drawable to be opened.
Returns
Returns a smart pointer to the drawable object.

Implements OdGiContext.

◆ paletteBackground()

virtual ODCOLORREF OdGiContextForIfcDatabase::paletteBackground ( ) const
virtual

Retrieves the current palette background color of the context object.

Returns
Returns the current palette background color.

Implements OdGiDefaultContext.

◆ setDatabase()

void OdGiContextForIfcDatabase::setDatabase ( OdIfc::OdIfcFilePtr  pIfcFile)

Sets a new IFC database to be vectorized.

Parameters
pIfcFile[in] A smart pointer to an IFC file object.

◆ setPaletteBackground()

virtual void OdGiContextForIfcDatabase::setPaletteBackground ( ODCOLORREF  paletteBackground)
virtual

Sets a new palette background color.

Parameters
paletteBackground[in] A new palette background color to be set.

Implements OdGiDefaultContext.

◆ setPlotGeneration()

virtual void OdGiContextForIfcDatabase::setPlotGeneration ( bool  plotGeneration)
virtual

Sets a new value of the plot generation flag.

Parameters
plotGeneration[in] A new value of the plot generation flag value to be set.
Remarks
The plot generation flag is equal to true if the vectorization is intended for hard copy output; otherwise, the flag is equal to false.

Implements OdGiDefaultContext.

◆ setRepresentationContext()

void OdGiContextForIfcDatabase::setRepresentationContext ( OdDAIObjectId  idRC)

Sets a new representation context.

Parameters
idRC[in] An identifier of an object that implements the representation context to be set.

◆ useGsModel()

bool OdGiContextForIfcDatabase::useGsModel ( ) const
virtual

Returns the current value of the flag that determines whether the Gs model should be used during the vectorization.

Returns
If the Gs model is used, the method returns true; otherwise, it returns false.

Reimplemented from OdGiDefaultContext.

Member Data Documentation

◆ m_paletteBackground

ODCOLORREF OdGiContextForIfcDatabase::m_paletteBackground
protected

Definition at line 69 of file IfcGiContext.h.


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