OdDbLSSymbolReference Struct Reference

#include <DbLSSymbolReference.h>

Public Types
enum	VertexMask { kLSAtStroke = 0 , kLSAtOrigin = 4 , kLSAtEnd = 8 , kLSAtVertex = 16 }
enum	Justify { kLSNoJustify = 0 , kLSJustifyLeft = 1 , kLSJustifyRight = 2 , kLSJustifyCenter = 3 }
enum	RotationType { kLSRelative = 0 , kLSAbsolute = 1 , kLSAdjusted = 2 }

Public Member Functions
	OdDbLSSymbolReference ()
bool	partialStrokes () const
void	setPartialStrokes (bool bSet)
bool	clipPartial () const
void	setClipPartial (bool bSet)
bool	allowStretch () const
void	setAllowStretch (bool bSet)
bool	partialProjected () const
void	setPartialProjected (bool bSet)
bool	useSymbolColor () const
void	setUseSymbolColor (bool bSet)
bool	useSymbolLineweight () const
void	setUseSymbolLineweight (bool bSet)
Justify	justify () const
void	setJustify (Justify nSet)
RotationType	rotationType () const
void	setRotationType (RotationType nSet)
OdUInt32	vertexMask () const
void	setVertexMask (OdUInt32 nVertexMask)
double	xOffset () const
void	setXOffset (double fOffset)
double	yOffset () const
void	setYOffset (double fOffset)
double	angle () const
void	setAngle (double fAngle)
OdInt32	strokeNumber () const
void	setStrokeNumber (OdInt32 nStroke)
OdDbObjectId	symbolComponent () const
void	setSymbolComponent (const OdDbObjectId &id)

Protected Attributes
bool	m_bPartialStrokes
bool	m_bClipPartial
bool	m_bAllowStretch
bool	m_bPartialProjected
bool	m_bSymbolColor
bool	m_bSymbolWeight
Justify	m_Justify
RotationType	m_RotationType
OdInt16	m_nVertexMask
double	m_fXOffset
double	m_fYOffset
double	m_fAngle
OdInt32	m_nStroke
OdDbHardPointerId	m_SymbolComponent

Friends
class	OdDbLSPointComponentImpl

Detailed Description

Dgn Line Style Symbol Reference.

See also

TD_Db <group OdDbLS_Classes>

Definition at line 38 of file DbLSSymbolReference.h.

Member Enumeration Documentation

Justify

enum OdDbLSSymbolReference::Justify

Enumerator
kLSNoJustify
kLSJustifyLeft
kLSJustifyRight
kLSJustifyCenter

Definition at line 47 of file DbLSSymbolReference.h.

RotationType

enum OdDbLSSymbolReference::RotationType

Enumerator
kLSRelative
kLSAbsolute
kLSAdjusted

Definition at line 54 of file DbLSSymbolReference.h.

VertexMask

enum OdDbLSSymbolReference::VertexMask

Enumerator
kLSAtStroke
kLSAtOrigin
kLSAtEnd
kLSAtVertex

Definition at line 40 of file DbLSSymbolReference.h.

Constructor & Destructor Documentation

OdDbLSSymbolReference()

OdDbLSSymbolReference::OdDbLSSymbolReference ( )

inline

Definition at line 78 of file DbLSSymbolReference.h.

Member Function Documentation

allowStretch()

bool OdDbLSSymbolReference::allowStretch ( ) const

inline

Returns true if symbol can be scaled.

Definition at line 123 of file DbLSSymbolReference.h.

angle()

double OdDbLSSymbolReference::angle ( ) const

inline

Returns symbol rotation angle.

Definition at line 230 of file DbLSSymbolReference.h.

clipPartial()

bool OdDbLSSymbolReference::clipPartial ( ) const

inline

Returns true if symbol clipping on partial strokes enabled.

Definition at line 112 of file DbLSSymbolReference.h.

justify()

Justify OdDbLSSymbolReference::justify ( ) const

inline

Returns symbol justification on stroke.

Definition at line 173 of file DbLSSymbolReference.h.

partialProjected()

bool OdDbLSSymbolReference::partialProjected ( ) const

inline

Returns true if project partial origin if it is beyond the end of line mode is enabled.

Definition at line 134 of file DbLSSymbolReference.h.

partialStrokes()

bool OdDbLSSymbolReference::partialStrokes ( ) const

inline

Returns true if partial strokes mode is enabled.

Remarks

If this mode is disabled: display whole symbol or none.

Definition at line 101 of file DbLSSymbolReference.h.

rotationType()

RotationType OdDbLSSymbolReference::rotationType ( ) const

inline

Returns symbol rotation mode.

Definition at line 184 of file DbLSSymbolReference.h.

setAllowStretch()

void OdDbLSSymbolReference::setAllowStretch ( bool  bSet )

inline

Enables symbol scalability.

Parameters

bSet	[in] New value to set.

Definition at line 129 of file DbLSSymbolReference.h.

setAngle()

void OdDbLSSymbolReference::setAngle ( double  fAngle )

inline

Sets symbol rotation angle.

Parameters

fAngle

[in] Rotation angle in radians.

Definition at line 236 of file DbLSSymbolReference.h.

setClipPartial()

void OdDbLSSymbolReference::setClipPartial ( bool  bSet )

inline

Enables symbol clipping on partial strokes mode.

Parameters

bSet	[in] New value to set.

Definition at line 118 of file DbLSSymbolReference.h.

setJustify()

void OdDbLSSymbolReference::setJustify ( Justify  nSet )

inline

Sets symbol justification on stroke.

Parameters

nSet	[in] New justification value to set.

Definition at line 179 of file DbLSSymbolReference.h.

setPartialProjected()

void OdDbLSSymbolReference::setPartialProjected ( bool  bSet )

inline

Sets project partial origin if it is beyond the end of line mode.

Parameters

bSet	[in] New mode to set.

Definition at line 140 of file DbLSSymbolReference.h.

setPartialStrokes()

void OdDbLSSymbolReference::setPartialStrokes ( bool  bSet )

inline

Sets partial stroke mode.

Parameters

bSet	[in] New value to set.

Definition at line 107 of file DbLSSymbolReference.h.

setRotationType()

void OdDbLSSymbolReference::setRotationType ( RotationType  nSet )

inline

Sets symbol rotation mode.

Parameters

nSet	[in] New rotation mode to set.

Definition at line 190 of file DbLSSymbolReference.h.

setStrokeNumber()

void OdDbLSSymbolReference::setStrokeNumber ( OdInt32  nStroke )

inline

Associate symbol with stroke.

Parameters

nStroke

[in] Stroke index.

Remarks

Must be set to -1 if symbol is configured for vertex symbol usage.

Definition at line 249 of file DbLSSymbolReference.h.

setSymbolComponent()

void OdDbLSSymbolReference::setSymbolComponent ( const OdDbObjectId &  id )

inline

Sets symbol component identifier with which this symbol reference will be associated.

Parameters

id	[in] Symbol component identifier.

Definition at line 260 of file DbLSSymbolReference.h.

setUseSymbolColor()

void OdDbLSSymbolReference::setUseSymbolColor ( bool  bSet )

inline

Sets symbol color usage mode.

Parameters

bSet	[in] New mode to set.

Definition at line 154 of file DbLSSymbolReference.h.

setUseSymbolLineweight()

void OdDbLSSymbolReference::setUseSymbolLineweight ( bool  bSet )

inline

Sets symbol lineweight usage mode.

Parameters

bSet	[in] New mode to set.

Definition at line 168 of file DbLSSymbolReference.h.

setVertexMask()

void OdDbLSSymbolReference::setVertexMask ( OdUInt32  nVertexMask )

inline

Sets vertex type for this symbol.

Parameters

nVertexMask

[in] Vertex type to set.

Remarks

Must be set to 0 if symbol is associated with stroke.

Definition at line 203 of file DbLSSymbolReference.h.

setXOffset()

void OdDbLSSymbolReference::setXOffset ( double  fOffset )

inline

Sets symbol offset in X direction.

Parameters

fOffset

[in] New offset to set.

Definition at line 214 of file DbLSSymbolReference.h.

setYOffset()

void OdDbLSSymbolReference::setYOffset ( double  fOffset )

inline

Sets symbol offset in Y direction.

Parameters

fOffset

[in] New offset to set.

Definition at line 225 of file DbLSSymbolReference.h.

strokeNumber()

OdInt32 OdDbLSSymbolReference::strokeNumber ( ) const

inline

Returns stroke index with which this symbol is associated.

Definition at line 241 of file DbLSSymbolReference.h.

symbolComponent()

OdDbObjectId OdDbLSSymbolReference::symbolComponent ( ) const

inline

Returns symbol component identifier with which this symbol reference is associated.

Definition at line 254 of file DbLSSymbolReference.h.

useSymbolColor()

bool OdDbLSSymbolReference::useSymbolColor ( ) const

inline

Returns true if symbol color usage enabled.

Remarks

Elsewhere line color will be used.

Definition at line 148 of file DbLSSymbolReference.h.

useSymbolLineweight()

bool OdDbLSSymbolReference::useSymbolLineweight ( ) const

inline

Returns true if symbol lineweight usage enabled.

Remarks

Elsewhere line lineweight will be used.

Definition at line 162 of file DbLSSymbolReference.h.

vertexMask()

OdUInt32 OdDbLSSymbolReference::vertexMask ( ) const

inline

Returns vertex type for this symbol.

Definition at line 195 of file DbLSSymbolReference.h.

xOffset()

double OdDbLSSymbolReference::xOffset ( ) const

inline

Returns symbol offset in X direction.

Definition at line 208 of file DbLSSymbolReference.h.

yOffset()

double OdDbLSSymbolReference::yOffset ( ) const

inline

Returns symbol offset in Y direction.

Definition at line 219 of file DbLSSymbolReference.h.

Friends And Related Function Documentation

OdDbLSPointComponentImpl

friend class OdDbLSPointComponentImpl

friend

Definition at line 263 of file DbLSSymbolReference.h.

Member Data Documentation

m_bAllowStretch

bool OdDbLSSymbolReference::m_bAllowStretch

protected

Definition at line 64 of file DbLSSymbolReference.h.

m_bClipPartial

bool OdDbLSSymbolReference::m_bClipPartial

protected

Definition at line 63 of file DbLSSymbolReference.h.

m_bPartialProjected

bool OdDbLSSymbolReference::m_bPartialProjected

protected

Definition at line 65 of file DbLSSymbolReference.h.

m_bPartialStrokes

bool OdDbLSSymbolReference::m_bPartialStrokes

protected

Definition at line 62 of file DbLSSymbolReference.h.

m_bSymbolColor

bool OdDbLSSymbolReference::m_bSymbolColor

protected

Definition at line 66 of file DbLSSymbolReference.h.

m_bSymbolWeight

bool OdDbLSSymbolReference::m_bSymbolWeight

protected

Definition at line 67 of file DbLSSymbolReference.h.

m_fAngle

double OdDbLSSymbolReference::m_fAngle

protected

Definition at line 73 of file DbLSSymbolReference.h.

m_fXOffset

double OdDbLSSymbolReference::m_fXOffset

protected

Definition at line 71 of file DbLSSymbolReference.h.

m_fYOffset

double OdDbLSSymbolReference::m_fYOffset

protected

Definition at line 72 of file DbLSSymbolReference.h.

m_Justify

Justify OdDbLSSymbolReference::m_Justify

protected

Definition at line 68 of file DbLSSymbolReference.h.

m_nStroke

OdInt32 OdDbLSSymbolReference::m_nStroke

protected

Definition at line 74 of file DbLSSymbolReference.h.

m_nVertexMask

OdInt16 OdDbLSSymbolReference::m_nVertexMask

protected

Definition at line 70 of file DbLSSymbolReference.h.

m_RotationType

RotationType OdDbLSSymbolReference::m_RotationType

protected

Definition at line 69 of file DbLSSymbolReference.h.

m_SymbolComponent

OdDbHardPointerId OdDbLSSymbolReference::m_SymbolComponent

protected

Definition at line 75 of file DbLSSymbolReference.h.

---

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

• DbLSSymbolReference.h