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

#include <GiMetafiler.h>

Inheritance diagram for OdGiMetafiler:
OdGiConveyorNode OdRxObject

Public Types

enum  CoordType {
  kUnknown = 0 , kModel , kWorld , kEye ,
  kDevice
}
 
enum  EOptions { kTextAsText = 1 , kNurbsAsNurbs = 2 , kPlineAsPline = 4 , kDisableImageConversion = 8 }
 

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdGiMetafiler)
 
virtual void setMetafile (OdGiGeometryMetafile *pMetafile)=0
 
virtual OdGiGeometryMetafilemetafile ()=0
 
virtual void exchangeMetafile (OdGiGeometryMetafile *pMetafile)=0
 
virtual void setDeviation (const OdGeDoubleArray &deviations)=0
 
virtual void setDeviation (const OdGiDeviation *pDeviation)=0
 
virtual void setDrawContext (OdGiConveyorContext *pDrawCtx)=0
 
virtual void setCoordinatesType (CoordType ct)=0
 
virtual CoordType coordinatesType () const =0
 
virtual bool saveTraits (const OdGiSubEntityTraitsData &entTraits, const OdGiSubEntityTraitsData *byBlockTraits=NULL)=0
 
virtual bool saveTraits (const OdGiSubEntityTraitsData *byBlockTraits)=0
 
virtual bool saveTraits ()=0
 
virtual void flush (bool bForceTraits=true)=0
 
virtual void add (OdGiGeometryMetafile::Record *pRec)=0
 
virtual void setOptions (OdUInt32 options)
 
virtual OdUInt32 options () const
 
- Public Member Functions inherited from OdGiConveyorNode
 ODRX_DECLARE_MEMBERS (OdGiConveyorNode)
 
virtual OdGiConveyorInputinput ()=0
 
virtual OdGiConveyorOutputoutput ()=0
 
- 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 ()
 
- Protected Member Functions inherited from OdGiConveyorNode
 OdGiConveyorNode ()
 

Detailed Description

Metafiler class.

<group OdGi_Classes>

Definition at line 237 of file GiMetafiler.h.

Member Enumeration Documentation

◆ CoordType

Coordinates types for geometry.

Enumerator
kUnknown 

Unknown.

kModel 

Model space coordinates.

kWorld 

World space coordinates.

kEye 

Eye space coordinates.

kDevice 

Device space coordinates.

Definition at line 290 of file GiMetafiler.h.

◆ EOptions

Metafiler storage options.

Enumerator
kTextAsText 

Keep text as text, not converted into geometry.

kNurbsAsNurbs 

Keep nurbs as nurbs, not simplified.

kPlineAsPline 

Keep pline as pline, not simplified.

kDisableImageConversion 

Disable image conversion.

Definition at line 366 of file GiMetafiler.h.

Member Function Documentation

◆ add()

virtual void OdGiMetafiler::add ( OdGiGeometryMetafile::Record pRec)
pure virtual

Adds a metafile record to the records list.

Parameters
pRec[in] Pointer to the metafile record to be added.

◆ coordinatesType()

virtual CoordType OdGiMetafiler::coordinatesType ( ) const
pure virtual

Retrieves the coordinates type used by this metafiler object.

Returns
Value from the CoordType enumeration that represents coordinates type for geometry.

◆ exchangeMetafile()

virtual void OdGiMetafiler::exchangeMetafile ( OdGiGeometryMetafile pMetafile)
pure virtual

Replaces a metafile, sets the last metafile record to be the current.

Parameters
pMetafile[in] Pointer to a geometry metafile.

◆ flush()

virtual void OdGiMetafiler::flush ( bool  bForceTraits = true)
pure virtual

Flushes all data to the metafile.

Parameters
bForceTraits[in] Flag that specifies whether data should be flushed even if geometry buffers are empty.

◆ metafile()

virtual OdGiGeometryMetafile * OdGiMetafiler::metafile ( )
pure virtual

Retrieves a metafile associated with this object.

Returns
Pointer to the geometry metafile.

◆ ODRX_DECLARE_MEMBERS()

OdGiMetafiler::ODRX_DECLARE_MEMBERS ( OdGiMetafiler  )

◆ options()

virtual OdUInt32 OdGiMetafiler::options ( ) const
inlinevirtual

Retrieves options used by this metafiler object.

Returns
Options used by this metafiler object.

Definition at line 391 of file GiMetafiler.h.

◆ saveTraits() [1/3]

virtual bool OdGiMetafiler::saveTraits ( )
pure virtual

Saves effective traits only into the metafile.

Returns
True if the underlying metafile is not NULL, false otherwise.

◆ saveTraits() [2/3]

virtual bool OdGiMetafiler::saveTraits ( const OdGiSubEntityTraitsData entTraits,
const OdGiSubEntityTraitsData byBlockTraits = NULL 
)
pure virtual

Saves traits into the metafile. Optionally saves ByBlock traits.

Parameters
entTraits[in] Entity traits to save.
byBlockTraits[in] Pointer to optional byBlock traits to save.
Returns
True if the underlying metafile is not NULL, false otherwise.

◆ saveTraits() [3/3]

virtual bool OdGiMetafiler::saveTraits ( const OdGiSubEntityTraitsData byBlockTraits)
pure virtual

Saves ByBlock traits into the metafile.

Parameters
byBlockTraits[in] Pointer to ByBlock traits to save.
Returns
True if the underlying metafile is not NULL, false otherwise.

◆ setCoordinatesType()

virtual void OdGiMetafiler::setCoordinatesType ( CoordType  ct)
pure virtual

Sets the coordinates type for geometry stored by the metafiler.

Parameters
ct[in] Coordinates type.

◆ setDeviation() [1/2]

virtual void OdGiMetafiler::setDeviation ( const OdGeDoubleArray deviations)
pure virtual

Sets the max deviation for curve tesselation.

Parameters
deviations[in] Array of deviation values.

◆ setDeviation() [2/2]

virtual void OdGiMetafiler::setDeviation ( const OdGiDeviation pDeviation)
pure virtual

Sets a deviation object to obtain max deviation for curve tesselation.

Parameters
pDeviation[in] Pointer to the deviation object.

◆ setDrawContext()

virtual void OdGiMetafiler::setDrawContext ( OdGiConveyorContext pDrawCtx)
pure virtual

Sets the draw context object (to access traits, etc).

Parameters
pDeviation[in] Pointer to the deviation object.

◆ setMetafile()

virtual void OdGiMetafiler::setMetafile ( OdGiGeometryMetafile pMetafile)
pure virtual

Sets a metafile.

Parameters
pMetafile[in] Pointer to a geometry metafile.

◆ setOptions()

virtual void OdGiMetafiler::setOptions ( OdUInt32  options)
inlinevirtual

Sets the metafiler options.

Parameters
options[in] Metafiler options.

Definition at line 383 of file GiMetafiler.h.


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