OdGiLineweightOverride Struct Reference

#include <GiLineweightOverride.h>

Public Member Functions
	OdGiLineweightOverride ()
void	setScaleOverride (double dLwdScale)
void	resetScaleOverride ()
bool	hasScaleOverride () const
double	scaleOverride () const
void	setPixelScale (double dPixScale)
double	pixelScale () const
void	setStyleOverride (OdPs::LineEndStyle lineCapStyle, OdPs::LineJoinStyle lineJoinStyle)
void	resetStyleOverride ()
bool	hasStyleOverride () const
OdPs::LineEndStyle	endStyleOverride () const
OdPs::LineJoinStyle	joinStyleOverride () const
bool	hasOverrides () const
bool	operator== (const OdGiLineweightOverride &lwdO2) const
bool	operator!= (const OdGiLineweightOverride &lwdO2) const

Protected Types
enum	Flags { kLwdOverrideScale = (1 << 0) , kLwdOverrideStyle = (1 << 1) }

Protected Attributes
OdUInt32	m_uFlags
double	m_dLwdScale
double	m_dPixScale
OdPs::LineEndStyle	m_lineCapStyle
OdPs::LineJoinStyle	m_lineJoinStyle

Detailed Description

This class provides an interface to override OdGsView lineweight settings.

See also

<link tv_working_with_attributes_lineweights, Work with Lineweights>

<group OdGi_Classes>

Definition at line 40 of file GiLineweightOverride.h.

Member Enumeration Documentation

Flags

enum OdGiLineweightOverride::Flags

protected

Enumerator
kLwdOverrideScale
kLwdOverrideStyle

Definition at line 43 of file GiLineweightOverride.h.

Constructor & Destructor Documentation

OdGiLineweightOverride()

OdGiLineweightOverride::OdGiLineweightOverride ( )

inline

Default constructor for the OdGiLineweightOverride class. Sets the following data members:

member Value Description m_uFlags 0 Lineweight flags m_dLwdScale 1.0 Lineweight scale m_dPixScale 1.0 Pixel scale m_lineCapStyle OdPs::kLesRound Style for line caps m_lineJoinStyle OdPs::kLjsRound Style for line joining

Definition at line 65 of file GiLineweightOverride.h.

Member Function Documentation

endStyleOverride()

OdPs::LineEndStyle OdGiLineweightOverride::endStyleOverride ( ) const

inline

Retrieves the line cap style override.

Returns

lineweight cap style override as a value from the OdPs::LineEndStyle enumeration.

Definition at line 172 of file GiLineweightOverride.h.

hasOverrides()

bool OdGiLineweightOverride::hasOverrides ( ) const

inline

Checks whether this lineweight has any overrides.

Returns

true if lineweight has overrides, false otherwise.

Definition at line 194 of file GiLineweightOverride.h.

hasScaleOverride()

bool OdGiLineweightOverride::hasScaleOverride ( ) const

inline

Checks whether this lineweight has a scale override.

Returns

true if lineweight override is present, false otherwise.

Definition at line 98 of file GiLineweightOverride.h.

hasStyleOverride()

bool OdGiLineweightOverride::hasStyleOverride ( ) const

inline

Checks whether this lineweight has line style overrides.

Returns

true if lineweight has line style overrides, false otherwise.

Definition at line 162 of file GiLineweightOverride.h.

joinStyleOverride()

OdPs::LineJoinStyle OdGiLineweightOverride::joinStyleOverride ( ) const

inline

Retrieves the line joining style override.

Returns

lineweight joining style override as a value from the OdPs::LineJoinStyle enumeration.

Definition at line 182 of file GiLineweightOverride.h.

operator!=()

bool OdGiLineweightOverride::operator!= ( const OdGiLineweightOverride &  lwdO2 ) const

inline

Inequality operator for this lineweight override. Lineweight overrides are not equal if one of the following conditions fails: Lineweight override flags are equal; Lineweight override scales are equal; Lineweight override line cap styles are equal; Lineweight override line join styles are equal;

Parameters

lwdO2

[in] Lineweight override to compare.

Returns

true if this lineweight override is not equal to the passed lineweight override, false otherwise.

Definition at line 242 of file GiLineweightOverride.h.

operator==()

bool OdGiLineweightOverride::operator== ( const OdGiLineweightOverride &  lwdO2 ) const

inline

Equality operator for this lineweight override. Lineweight overrides are equal if: Lineweight override flags are equal; Lineweight override scales are equal; Lineweight override line cap styles are equal; Lineweight override line join styles are equal;

Parameters

lwdO2

[in] Lineweight override to compare.

Returns

true if this lineweight override is equal to the passed lineweight override, false otherwise.

Definition at line 212 of file GiLineweightOverride.h.

pixelScale()

double OdGiLineweightOverride::pixelScale ( ) const

inline

Retrieves the pixel scale value.

Returns

pixel scale as a value of the double type.

Definition at line 130 of file GiLineweightOverride.h.

resetScaleOverride()

void OdGiLineweightOverride::resetScaleOverride ( )

inline

Resets scale overrides.

Definition at line 86 of file GiLineweightOverride.h.

resetStyleOverride()

void OdGiLineweightOverride::resetStyleOverride ( )

inline

Resets line style overrides.

Definition at line 150 of file GiLineweightOverride.h.

scaleOverride()

double OdGiLineweightOverride::scaleOverride ( ) const

inline

Retrieves the lineweight scale override value.

Returns

lineweight scale override as a value of the double type.

Definition at line 109 of file GiLineweightOverride.h.

setPixelScale()

void OdGiLineweightOverride::setPixelScale ( double  dPixScale )

inline

Specifies pixel scale property.

Parameters

dPixScale

[in] Pixel scale value.

Definition at line 119 of file GiLineweightOverride.h.

setScaleOverride()

void OdGiLineweightOverride::setScaleOverride ( double  dLwdScale )

inline

Overrides scale properties.

Parameters

dLwdScale

[in] Lineweight scale.

Definition at line 77 of file GiLineweightOverride.h.

setStyleOverride()

void OdGiLineweightOverride::setStyleOverride ( OdPs::LineEndStyle  lineCapStyle, OdPs::LineJoinStyle  lineJoinStyle  )

inline

Overrides line style properties.

Parameters

lineCapStyle	[in] Style for a line cap.
lineJoinStyle	[in] Style for a line joining.

Definition at line 141 of file GiLineweightOverride.h.

Member Data Documentation

m_dLwdScale

double OdGiLineweightOverride::m_dLwdScale

protected

Definition at line 49 of file GiLineweightOverride.h.

m_dPixScale

double OdGiLineweightOverride::m_dPixScale

protected

Definition at line 50 of file GiLineweightOverride.h.

m_lineCapStyle

OdPs::LineEndStyle OdGiLineweightOverride::m_lineCapStyle

protected

Definition at line 51 of file GiLineweightOverride.h.

m_lineJoinStyle

OdPs::LineJoinStyle OdGiLineweightOverride::m_lineJoinStyle

protected

Definition at line 52 of file GiLineweightOverride.h.

m_uFlags

OdUInt32 OdGiLineweightOverride::m_uFlags

protected

Definition at line 48 of file GiLineweightOverride.h.

---

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

• GiLineweightOverride.h