CFx SDK Documentation  2022 SP0
Public Member Functions | List of all members
OdPsPlotStyleTable Class Referenceabstract

#include <PlotStyles.h>

Inheritance diagram for OdPsPlotStyleTable:
OdRxObject

Public Member Functions

 ODRX_DECLARE_MEMBERS (OdPsPlotStyleTable)
 
virtual OdRxObjectPtr clone () const =0
 
virtual void copyFrom (const OdRxObject *pSource)=0
 
virtual bool isApplyScaleFactor () const =0
 
virtual OdString description () const =0
 
virtual double scaleFactor () const =0
 
virtual bool isDisplayCustomLineweightUnits () const =0
 
virtual double getLineweightAt (OdUInt32 index) const =0
 
virtual OdPsPlotStylePtr plotStyleAt (const OdString &name) const =0
 
virtual OdPsPlotStylePtr plotStyleAt (int index) const =0
 
virtual unsigned int plotStyleSize () const =0
 
virtual unsigned int lineweightSize () const =0
 
virtual bool isAciTableAvailable () const =0
 
virtual OdPsPlotStylePtr addNewPlotStyle (const OdString &styleName)=0
 
virtual OdPsPlotStylePtr delPlotStyle (OdPsPlotStylePtr pPsPtr)=0
 
virtual void setDescription (const OdString &desc)=0
 
virtual void setScaleFactor (double scFac)=0
 
virtual void setApplyScaleFactor (bool flag)=0
 
virtual void setDisplayCustomLineweightUnits (bool flag)=0
 
virtual void setLineweightAt (double value, OdUInt32 index)=0
 
virtual void setLineweights (const OdGeDoubleArray &lineweights)=0
 
virtual void setAciTableAvailable (bool flag)=0
 
virtual void setPlotStylesIndexed (const OdPsPlotStylesArray plotStylesIndexed)=0
 
virtual void setPlotStyles (const OdPsPlotStylesMap plotStyles)=0
 
virtual void addPlotStyle (OdPsPlotStyle *pPs)=0
 
virtual void setOrdering (const OdStringArray &order)=0
 
virtual OdPsPlotStylesMap plotStyles () const =0
 
virtual OdPsPlotStylesArray plotStylesIndexed () const =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 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 implements Plot Style Tables.

Corresponding C++ library: PlotStyleSvcs

<group Other_Classes>

Definition at line 438 of file PlotStyles.h.

Member Function Documentation

◆ addNewPlotStyle()

virtual OdPsPlotStylePtr OdPsPlotStyleTable::addNewPlotStyle ( const OdString styleName)
pure virtual

◆ addPlotStyle()

virtual void OdPsPlotStyleTable::addPlotStyle ( OdPsPlotStyle pPs)
pure virtual

◆ clone()

virtual OdRxObjectPtr OdPsPlotStyleTable::clone ( ) const
pure virtual

Creates a clone of this object, and returns a pointer to the clone.

Reimplemented from OdRxObject.

◆ copyFrom()

virtual void OdPsPlotStyleTable::copyFrom ( const OdRxObject pSource)
pure virtual

details Copies the contents of the specified object into this object.

Parameters
pSource[in] Pointer to the source object.
Remarks
The default implementation of this function does nothing but throw an eNotApplicable exception.

Throws: eNotApplicable Exception

Reimplemented from OdRxObject.

◆ delPlotStyle()

virtual OdPsPlotStylePtr OdPsPlotStyleTable::delPlotStyle ( OdPsPlotStylePtr  pPsPtr)
pure virtual

◆ description()

virtual OdString OdPsPlotStyleTable::description ( ) const
pure virtual

Returns the description of this PlotStyleTable object.

◆ getLineweightAt()

virtual double OdPsPlotStyleTable::getLineweightAt ( OdUInt32  index) const
pure virtual

Returns the lineweight for the specified entry in this PlotStyleTable object.

Parameters
index[in] PlotStyle index.

◆ isAciTableAvailable()

virtual bool OdPsPlotStyleTable::isAciTableAvailable ( ) const
pure virtual

◆ isApplyScaleFactor()

virtual bool OdPsPlotStyleTable::isApplyScaleFactor ( ) const
pure virtual

Returns true if and only if the global scale factor is to be applied to non-ISO linetypes for this PlotStyleTable object.

◆ isDisplayCustomLineweightUnits()

virtual bool OdPsPlotStyleTable::isDisplayCustomLineweightUnits ( ) const
pure virtual

Returns true if and only if Custom Lineweight Units are to be displayed for this PlotStyleTable object.

◆ lineweightSize()

virtual unsigned int OdPsPlotStyleTable::lineweightSize ( ) const
pure virtual

◆ ODRX_DECLARE_MEMBERS()

OdPsPlotStyleTable::ODRX_DECLARE_MEMBERS ( OdPsPlotStyleTable  )

◆ plotStyleAt() [1/2]

virtual OdPsPlotStylePtr OdPsPlotStyleTable::plotStyleAt ( const OdString name) const
pure virtual

Returns the specified PlotStyle in this PlotStyleTable object.

Parameters
name[in] Plot Style name.

◆ plotStyleAt() [2/2]

virtual OdPsPlotStylePtr OdPsPlotStyleTable::plotStyleAt ( int  index) const
pure virtual

Returns the specified PlotStyle in this PlotStyleTable object.

Parameters
index[in] PlotStyle index.

◆ plotStyles()

virtual OdPsPlotStylesMap OdPsPlotStyleTable::plotStyles ( ) const
pure virtual

◆ plotStylesIndexed()

virtual OdPsPlotStylesArray OdPsPlotStyleTable::plotStylesIndexed ( ) const
pure virtual

◆ plotStyleSize()

virtual unsigned int OdPsPlotStyleTable::plotStyleSize ( ) const
pure virtual

Returns the logical length of this PlotStyle

◆ scaleFactor()

virtual double OdPsPlotStyleTable::scaleFactor ( ) const
pure virtual

Returns the global scale factor to be applied to non-ISO linetypes for this PlotStyleTable object.

◆ setAciTableAvailable()

virtual void OdPsPlotStyleTable::setAciTableAvailable ( bool  flag)
pure virtual

◆ setApplyScaleFactor()

virtual void OdPsPlotStyleTable::setApplyScaleFactor ( bool  flag)
pure virtual

◆ setDescription()

virtual void OdPsPlotStyleTable::setDescription ( const OdString desc)
pure virtual

◆ setDisplayCustomLineweightUnits()

virtual void OdPsPlotStyleTable::setDisplayCustomLineweightUnits ( bool  flag)
pure virtual

◆ setLineweightAt()

virtual void OdPsPlotStyleTable::setLineweightAt ( double  value,
OdUInt32  index 
)
pure virtual

◆ setLineweights()

virtual void OdPsPlotStyleTable::setLineweights ( const OdGeDoubleArray lineweights)
pure virtual

◆ setOrdering()

virtual void OdPsPlotStyleTable::setOrdering ( const OdStringArray order)
pure virtual

◆ setPlotStyles()

virtual void OdPsPlotStyleTable::setPlotStyles ( const OdPsPlotStylesMap  plotStyles)
pure virtual

◆ setPlotStylesIndexed()

virtual void OdPsPlotStyleTable::setPlotStylesIndexed ( const OdPsPlotStylesArray  plotStylesIndexed)
pure virtual

◆ setScaleFactor()

virtual void OdPsPlotStyleTable::setScaleFactor ( double  scFac)
pure virtual

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