CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
OdDbLSStroke Struct Reference

#include <DbLSStroke.h>

Public Types

enum  WidthMode { kLSNoWidth = 0 , kLSWidthLeft = 1 , kLSWidthRight = 2 , kLSWidthFull = 3 }
 
enum  CapMode {
  kLSCapsClosed = 0 , kLSCapsOpen = 1 , kLSCapsExtended = 2 , kLSCapsHexagon = 3 ,
  kLSCapsOctagon = 4 , kLSCapsDecagon = 5 , kLSCapsArc = 30
}
 

Public Member Functions

 OdDbLSStroke ()
 
bool isDash () const
 
bool isGap () const
 
void setDash ()
 
void setGap ()
 
void setIsDash (bool bSet)
 
bool bypassCorner () const
 
void setBypassCorner (bool bSet)
 
bool canBeScaled () const
 
void setCanBeScaled (bool bSet)
 
bool invertAtOrigin () const
 
void setInvertAtOrigin (bool bSet)
 
bool invertAtEnd () const
 
void setInvertAtEnd (bool bSet)
 
double length () const
 
void setLength (double fLen)
 
double startWidth () const
 
void setStartWidth (double fWidth)
 
double endWidth () const
 
void setEndWidth (double fWidth)
 
WidthMode widthMode () const
 
void setWidthMode (WidthMode mode)
 
CapMode capMode () const
 
void setCapMode (CapMode mode)
 

Protected Attributes

bool m_bIsDash
 
bool m_bBypassCorner
 
bool m_bCanBeScaled
 
bool m_bDontInvertAtOrigin
 
bool m_bDontInvertAtEnd
 
double m_fLength
 
double m_fStartWidth
 
double m_fEndWidth
 
WidthMode m_WidthMode
 
CapMode m_CapMode
 

Friends

class OdDbLSStrokePatternComponentImpl
 

Detailed Description

Dgn Line Style Stroke.

See also
TD_Db <group OdDbLS_Classes>

Definition at line 38 of file DbLSStroke.h.

Member Enumeration Documentation

◆ CapMode

enum OdDbLSStroke::CapMode
Enumerator
kLSCapsClosed 
kLSCapsOpen 
kLSCapsExtended 
kLSCapsHexagon 
kLSCapsOctagon 
kLSCapsDecagon 
kLSCapsArc 

Definition at line 47 of file DbLSStroke.h.

◆ WidthMode

enum OdDbLSStroke::WidthMode
Enumerator
kLSNoWidth 
kLSWidthLeft 
kLSWidthRight 
kLSWidthFull 

Definition at line 40 of file DbLSStroke.h.

Constructor & Destructor Documentation

◆ OdDbLSStroke()

OdDbLSStroke::OdDbLSStroke ( )
inline

Definition at line 79 of file DbLSStroke.h.

Member Function Documentation

◆ bypassCorner()

bool OdDbLSStroke::bypassCorner ( ) const
inline

Returns corners bypass flag.

Definition at line 119 of file DbLSStroke.h.

◆ canBeScaled()

bool OdDbLSStroke::canBeScaled ( ) const
inline

Returns true if variable stroke length is enabled.

Definition at line 130 of file DbLSStroke.h.

◆ capMode()

CapMode OdDbLSStroke::capMode ( ) const
inline

Returns stroke caps type.

Definition at line 207 of file DbLSStroke.h.

◆ endWidth()

double OdDbLSStroke::endWidth ( ) const
inline

Returns stroke end width.

Definition at line 185 of file DbLSStroke.h.

◆ invertAtEnd()

bool OdDbLSStroke::invertAtEnd ( ) const
inline

Returns true if invert stroke at end mode is enabled.

Definition at line 152 of file DbLSStroke.h.

◆ invertAtOrigin()

bool OdDbLSStroke::invertAtOrigin ( ) const
inline

Returns true if invert stroke at origin mode is enabled.

Definition at line 141 of file DbLSStroke.h.

◆ isDash()

bool OdDbLSStroke::isDash ( ) const
inline

Returns true if this stroke is dash.

Definition at line 96 of file DbLSStroke.h.

◆ isGap()

bool OdDbLSStroke::isGap ( ) const
inline

Returns true if this stroke is gap.

Definition at line 100 of file DbLSStroke.h.

◆ length()

double OdDbLSStroke::length ( ) const
inline

Returns stroke length.

Definition at line 163 of file DbLSStroke.h.

◆ setBypassCorner()

void OdDbLSStroke::setBypassCorner ( bool  bSet)
inline

Sets corners bypass flag.

Parameters
bSet[in] New value to set.

Definition at line 125 of file DbLSStroke.h.

◆ setCanBeScaled()

void OdDbLSStroke::setCanBeScaled ( bool  bSet)
inline

Sets variable length flag.

Parameters
bSet[in] New value to set.

Definition at line 136 of file DbLSStroke.h.

◆ setCapMode()

void OdDbLSStroke::setCapMode ( CapMode  mode)
inline

Sets stroke caps type.

Parameters
mode[in] New stroke caps type.

Definition at line 213 of file DbLSStroke.h.

◆ setDash()

void OdDbLSStroke::setDash ( )
inline

Sets this stroke as dash.

Definition at line 104 of file DbLSStroke.h.

◆ setEndWidth()

void OdDbLSStroke::setEndWidth ( double  fWidth)
inline

Sets stroke end width.

Parameters
fWidth[in] New stroke end width.

Definition at line 191 of file DbLSStroke.h.

◆ setGap()

void OdDbLSStroke::setGap ( )
inline

Sets this stroke as gap.

Definition at line 108 of file DbLSStroke.h.

◆ setInvertAtEnd()

void OdDbLSStroke::setInvertAtEnd ( bool  bSet)
inline

Sets invert stroke at end mode flag.

Parameters
bSet[in] New value to set.

Definition at line 158 of file DbLSStroke.h.

◆ setInvertAtOrigin()

void OdDbLSStroke::setInvertAtOrigin ( bool  bSet)
inline

Sets invert stroke at origin mode flag.

Parameters
bSet[in] New value to set.

Definition at line 147 of file DbLSStroke.h.

◆ setIsDash()

void OdDbLSStroke::setIsDash ( bool  bSet)
inline

Sets isDash flag for this stroke.

Parameters
bSet[in] New flag to set.

Definition at line 114 of file DbLSStroke.h.

◆ setLength()

void OdDbLSStroke::setLength ( double  fLen)
inline

Sets stroke length.

Parameters
fLen[in] New stroke length.

Definition at line 169 of file DbLSStroke.h.

◆ setStartWidth()

void OdDbLSStroke::setStartWidth ( double  fWidth)
inline

Sets stroke start width.

Parameters
fWidth[in] New stroke start width.

Definition at line 180 of file DbLSStroke.h.

◆ setWidthMode()

void OdDbLSStroke::setWidthMode ( WidthMode  mode)
inline

Sets stroke width mode.

Parameters
mode[in] New stroke width mode.

Definition at line 202 of file DbLSStroke.h.

◆ startWidth()

double OdDbLSStroke::startWidth ( ) const
inline

Returns stroke start width.

Definition at line 174 of file DbLSStroke.h.

◆ widthMode()

WidthMode OdDbLSStroke::widthMode ( ) const
inline

Returns stroke width mode.

Definition at line 196 of file DbLSStroke.h.

Friends And Related Function Documentation

◆ OdDbLSStrokePatternComponentImpl

friend class OdDbLSStrokePatternComponentImpl
friend

Definition at line 216 of file DbLSStroke.h.

Member Data Documentation

◆ m_bBypassCorner

bool OdDbLSStroke::m_bBypassCorner
protected

Definition at line 60 of file DbLSStroke.h.

◆ m_bCanBeScaled

bool OdDbLSStroke::m_bCanBeScaled
protected

Definition at line 61 of file DbLSStroke.h.

◆ m_bDontInvertAtEnd

bool OdDbLSStroke::m_bDontInvertAtEnd
protected

Definition at line 71 of file DbLSStroke.h.

◆ m_bDontInvertAtOrigin

bool OdDbLSStroke::m_bDontInvertAtOrigin
protected

Definition at line 70 of file DbLSStroke.h.

◆ m_bIsDash

bool OdDbLSStroke::m_bIsDash
protected

Definition at line 59 of file DbLSStroke.h.

◆ m_CapMode

CapMode OdDbLSStroke::m_CapMode
protected

Definition at line 76 of file DbLSStroke.h.

◆ m_fEndWidth

double OdDbLSStroke::m_fEndWidth
protected

Definition at line 74 of file DbLSStroke.h.

◆ m_fLength

double OdDbLSStroke::m_fLength
protected

Definition at line 72 of file DbLSStroke.h.

◆ m_fStartWidth

double OdDbLSStroke::m_fStartWidth
protected

Definition at line 73 of file DbLSStroke.h.

◆ m_WidthMode

WidthMode OdDbLSStroke::m_WidthMode
protected

Definition at line 75 of file DbLSStroke.h.

The documentation for this struct was generated from the following file:
Generated on Thu Feb 24 2022 15:10:48