OdPsPlotStyleData Class Reference

#include <PlotStyles.h>

Public Types
enum	ColorPolicy { kDither = 1, kGrayScale = 2, kNotUseObject = 4 }

Public Member Functions
	OdPsPlotStyleData ()
bool	operator== (const OdPsPlotStyleData &other) const
bool	operator!= (const OdPsPlotStyleData &other) const
const OdCmEntityColor &	color () const
OdInt16	colorPolicy () const
OdInt16	physicalPenNumber () const
OdInt16	virtualPenNumber () const
int	screening () const
double	linePatternSize () const
OdPs::LineType	linetype () const
bool	isAdaptiveLinetype () const
bool	isGrayScaleOn () const
bool	isDitherOn () const
double	lineweight () const
OdPs::FillStyle	fillStyle () const
OdPs::LineEndStyle	endStyle () const
OdPs::LineJoinStyle	joinStyle () const
void	setColor (const OdCmEntityColor &color)
void	setColorPolicy (OdInt16 colorPolicy)
void	setPhysicalPenNumber (OdInt16 physicalPenNumber)
void	setVirtualPenNumber (OdInt16 virtualPenNumber)
void	setScreening (int screening)
void	setLinePatternSize (double linePatternSize)
void	setLinetype (OdPs::LineType linetype)
void	setAdaptiveLinetype (bool adaptiveLinetype)
void	setGrayScaleOn (bool grayScaleOn)
void	setDitherOn (bool ditherOn)
void	setLineweight (double lineweight)
void	setFillStyle (OdPs::FillStyle fillStyle)
void	setEndStyle (OdPs::LineEndStyle lineEndStyle)
void	setJoinStyle (OdPs::LineJoinStyle lineJoinStyle)

Static Public Attributes
FIRSTDLL_EXPORT static FIRSTDLL_EXPORT_STATIC const OdPsPlotStyleData	kDefault

Protected Attributes
OdCmEntityColor	m_color
OdInt16	m_colorPolicy
bool	m_bAdaptiveLinetype
OdInt16	m_screening
OdInt16	m_physPenNum
OdInt16	m_virtPenNum
OdInt16	m_psLt
OdInt16	m_fillStyle
OdInt16	m_lineEndStyle
OdInt16	m_lineJoinStyle
double	m_dLinePatSz
double	m_lineweight

Detailed Description

This class represents PlotStyle data for a single color (or object color) in OdPsPlotStyle objects.

Corresponding C++ library: PlotStyleSvcs <group Other_Classes>

Definition at line 134 of file PlotStyles.h.

Member Enumeration Documentation

ColorPolicy

enum OdPsPlotStyleData::ColorPolicy

Enumerator
kDither
kGrayScale
kNotUseObject

Definition at line 137 of file PlotStyles.h.

Constructor & Destructor Documentation

OdPsPlotStyleData()

OdPsPlotStyleData::OdPsPlotStyleData ( )

inline

Definition at line 160 of file PlotStyles.h.

Member Function Documentation

color()

const OdCmEntityColor& OdPsPlotStyleData::color ( ) const

inline

Returns the Color for this PlotStyleData object.

Definition at line 208 of file PlotStyles.h.

colorPolicy()

OdInt16 OdPsPlotStyleData::colorPolicy ( ) const

inline

Definition at line 210 of file PlotStyles.h.

endStyle()

OdPs::LineEndStyle OdPsPlotStyleData::endStyle ( ) const

inline

Returns the Line End Style for this PlotStyleData object.

Definition at line 262 of file PlotStyles.h.

fillStyle()

OdPs::FillStyle OdPsPlotStyleData::fillStyle ( ) const

inline

Returns the Fill Style for this PlotStyleData object.

Definition at line 258 of file PlotStyles.h.

isAdaptiveLinetype()

bool OdPsPlotStyleData::isAdaptiveLinetype ( ) const

inline

Returns true if an only if the Linetype is adaptive for this PlotStyleData object.

Definition at line 242 of file PlotStyles.h.

isDitherOn()

bool OdPsPlotStyleData::isDitherOn ( ) const

inline

Returns true if an only if Dither is on for this PlotStyleData object.

Definition at line 250 of file PlotStyles.h.

isGrayScaleOn()

bool OdPsPlotStyleData::isGrayScaleOn ( ) const

inline

Returns true if an only if Grayscale is on for this PlotStyleData object.

Definition at line 246 of file PlotStyles.h.

joinStyle()

OdPs::LineJoinStyle OdPsPlotStyleData::joinStyle ( ) const

inline

Returns the Line Join Style for this PlotStyleData object.

Definition at line 266 of file PlotStyles.h.

linePatternSize()

double OdPsPlotStyleData::linePatternSize ( ) const

inline

Returns the Line Pattern Size for this PlotStyleData object.

Definition at line 233 of file PlotStyles.h.

linetype()

OdPs::LineType OdPsPlotStyleData::linetype ( ) const

inline

Returns the Linetype for this PlotStyleData object.

Definition at line 237 of file PlotStyles.h.

lineweight()

double OdPsPlotStyleData::lineweight ( ) const

inline

Returns the Lineweight for this PlotStyleData object.

Definition at line 254 of file PlotStyles.h.

operator!=()

bool OdPsPlotStyleData::operator!= ( const OdPsPlotStyleData &  other ) const

inline

Inequality operator.

Definition at line 203 of file PlotStyles.h.

operator==()

bool OdPsPlotStyleData::operator== ( const OdPsPlotStyleData &  other ) const

inline

Equality operator.

Definition at line 182 of file PlotStyles.h.

physicalPenNumber()

OdInt16 OdPsPlotStyleData::physicalPenNumber ( ) const

inline

Returns the Physical Pen Number for this PlotStyleData object.

Definition at line 214 of file PlotStyles.h.

screening()

int OdPsPlotStyleData::screening ( ) const

inline

Returns the Screening for this PlotStyleData object.

Returns

Returns a value in the range [0.0 .. 100.0]. 0 indicates white. 100 indicates colors at their full intensities.

Definition at line 228 of file PlotStyles.h.

setAdaptiveLinetype()

void OdPsPlotStyleData::setAdaptiveLinetype ( bool  adaptiveLinetype )

inline

Controls if the Linetype is adaptive for this PlotStyleData object.

Parameters

adaptiveLinetype

[in] Controls Adaptive Linetype.

Definition at line 320 of file PlotStyles.h.

setColor()

void OdPsPlotStyleData::setColor ( const OdCmEntityColor &  color )

inline

Sets the Color for this PlotStyleData object.

Parameters

color

[in] Color.

Definition at line 272 of file PlotStyles.h.

setColorPolicy()

void OdPsPlotStyleData::setColorPolicy ( OdInt16  colorPolicy )

inline

Definition at line 281 of file PlotStyles.h.

setDitherOn()

void OdPsPlotStyleData::setDitherOn ( bool  ditherOn )

inline

Controls if Dither is on for this PlotStyleData object.

Parameters

ditherOn

[in] Controls Dither On.

Definition at line 343 of file PlotStyles.h.

setEndStyle()

void OdPsPlotStyleData::setEndStyle ( OdPs::LineEndStyle  lineEndStyle )

inline

Sets the LineEndStyle for this PlotStyleData object.

Parameters

LineEndStyle

[in] LineEndStyle.

Definition at line 358 of file PlotStyles.h.

setFillStyle()

void OdPsPlotStyleData::setFillStyle ( OdPs::FillStyle  fillStyle )

inline

Sets the Fill Style for this PlotStyleData object.

Parameters

fillStyle

[in] Fill Style.

Definition at line 353 of file PlotStyles.h.

setGrayScaleOn()

void OdPsPlotStyleData::setGrayScaleOn ( bool  grayScaleOn )

inline

Controls if Grayscale is on for this PlotStyleData object.

Parameters

grayScaleOn

[in] Controls Grayscale On.

Definition at line 325 of file PlotStyles.h.

setJoinStyle()

void OdPsPlotStyleData::setJoinStyle ( OdPs::LineJoinStyle  lineJoinStyle )

inline

Sets the Line Join Style for this PlotStyleData object.

Parameters

lineJoinStyle

[in] Line Join Style.

Definition at line 364 of file PlotStyles.h.

setLinePatternSize()

void OdPsPlotStyleData::setLinePatternSize ( double  linePatternSize )

inline

Sets the Line Pattern Size for this PlotStyleData object.

Parameters

linePatternSize

[in] Line Pattern Size.

Definition at line 309 of file PlotStyles.h.

setLinetype()

void OdPsPlotStyleData::setLinetype ( OdPs::LineType  linetype )

inline

Sets the Linetype for this PlotStyleData object.

Parameters

linetype

[in] Linetype.

Definition at line 314 of file PlotStyles.h.

setLineweight()

void OdPsPlotStyleData::setLineweight ( double  lineweight )

inline

Sets the Lineweight for this PlotStyleData object.

Parameters

lineweight

[in] Lineweight.

Definition at line 348 of file PlotStyles.h.

setPhysicalPenNumber()

void OdPsPlotStyleData::setPhysicalPenNumber ( OdInt16  physicalPenNumber )

inline

Sets the Physical Pen Number for this PlotStyleData object.

Parameters

physicalPenNumber

[in] Physical Pen Number.

Definition at line 287 of file PlotStyles.h.

setScreening()

void OdPsPlotStyleData::setScreening ( int  screening )

inline

Sets the Screening for this PlotStyleData object.

Parameters

screening

[in] Screening.

Remarks

screening must be in range [0.0 .. 100.0]. 0 indicates white. 100 indicates the colors at their full intensities.

Definition at line 303 of file PlotStyles.h.

setVirtualPenNumber()

void OdPsPlotStyleData::setVirtualPenNumber ( OdInt16  virtualPenNumber )

inline

Sets the Virtual Pen Number for this PlotStyleData object.

Parameters

virtualPenNumber

[in] Virtual Pen Number.

Definition at line 292 of file PlotStyles.h.

virtualPenNumber()

OdInt16 OdPsPlotStyleData::virtualPenNumber ( ) const

inline

Returns the Virtual Pen Number for this PlotStyleData object.

Definition at line 218 of file PlotStyles.h.

Member Data Documentation

kDefault

FIRSTDLL_EXPORT static FIRSTDLL_EXPORT_STATIC const OdPsPlotStyleData OdPsPlotStyleData::kDefault

static

Definition at line 175 of file PlotStyles.h.

m_bAdaptiveLinetype

bool OdPsPlotStyleData::m_bAdaptiveLinetype

protected

Definition at line 147 of file PlotStyles.h.

m_color

OdCmEntityColor OdPsPlotStyleData::m_color

protected

Definition at line 145 of file PlotStyles.h.

m_colorPolicy

OdInt16 OdPsPlotStyleData::m_colorPolicy

protected

Definition at line 146 of file PlotStyles.h.

m_dLinePatSz

double OdPsPlotStyleData::m_dLinePatSz

protected

Definition at line 155 of file PlotStyles.h.

m_fillStyle

OdInt16 OdPsPlotStyleData::m_fillStyle

protected

Definition at line 152 of file PlotStyles.h.

m_lineEndStyle

OdInt16 OdPsPlotStyleData::m_lineEndStyle

protected

Definition at line 153 of file PlotStyles.h.

m_lineJoinStyle

OdInt16 OdPsPlotStyleData::m_lineJoinStyle

protected

Definition at line 154 of file PlotStyles.h.

m_lineweight

double OdPsPlotStyleData::m_lineweight

protected

Definition at line 156 of file PlotStyles.h.

m_physPenNum

OdInt16 OdPsPlotStyleData::m_physPenNum

protected

Definition at line 149 of file PlotStyles.h.

m_psLt

OdInt16 OdPsPlotStyleData::m_psLt

protected

Definition at line 151 of file PlotStyles.h.

m_screening

OdInt16 OdPsPlotStyleData::m_screening

protected

Definition at line 148 of file PlotStyles.h.

m_virtPenNum

OdInt16 OdPsPlotStyleData::m_virtPenNum

protected

Definition at line 150 of file PlotStyles.h.

---

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

• PlotStyles.h