#include <DbLSStrokePatternComponent.h>

Inheritance diagram for OdDbLSStrokePatternComponent:

Public Types
enum	PhaseMode { kLSPhaseDistance = 0, kLSPhaseFraction = 1, kLSPhaseCentered = 2 }

Public Types inherited from OdGiDrawable
enum	SetAttributesFlags { kDrawableNone = 0, kDrawableIsAnEntity = 1, kDrawableUsesNesting = 2, kDrawableIsCompoundObject = 4, kDrawableViewIndependentViewportDraw = 8, kDrawableIsInvisible = 16, kDrawableHasAttributes = 32, kDrawableRegenTypeDependantGeometry = 64, kDrawableIsDimension = (kDrawableIsAnEntity + kDrawableIsCompoundObject + 128), kDrawableRegenDraw = 256, kDrawableStandardDisplaySingleLOD = 512, kDrawableShadedDisplaySingleLOD = 1024, kDrawableViewDependentViewportDraw = 2048, kDrawableBlockDependentViewportDraw = 4096, kDrawableIsExternalReference = 8192, kDrawableNotPlottable = 16384, kLastFlag = kDrawableNotPlottable }

enum	DrawableType { kGeometry = 0, kDistantLight = 1, kPointLight = 2, kSpotLight = 3, kAmbientLight, kSolidBackground, kGradientBackground, kImageBackground, kGroundPlaneBackground, kViewport, kWebLight, kSkyBackground, kImageBasedLightingBackground }

Public Member Functions
	ODDB_DECLARE_MEMBERS (OdDbLSStrokePatternComponent)

	OdDbLSStrokePatternComponent ()

double	autoPhase () const

void	setAutoPhase (double fPhase)

bool	hasIterationLimit () const

void	setHasIterationLimit (bool bSet)

OdDbLSStroke *	insertStroke (double fLength=1.0, double fStartWidth=0.0, double fEndWidth=0.0, OdDbLSStroke::WidthMode widthMode=OdDbLSStroke::kLSNoWidth, OdDbLSStroke::CapMode capMode=OdDbLSStroke::kLSCapsClosed)

OdDbLSStroke *	insertStroke (const OdDbLSStroke *pStroke)

OdDbLSStroke *	stroke (OdUInt32 nStroke) const

void	deleteStroke (OdUInt32 nStroke)

OdUInt32	numberStrokes () const

bool	isSingleSegment () const

void	setIsSingleSegment (bool bSet)

OdInt32	iterationLimit () const

void	setIterationLimit (OdInt32 nLimit)

double	phase () const

void	setPhase (double fPhase)

PhaseMode	phaseMode () const

void	setPhaseMode (PhaseMode mode)

Public Member Functions inherited from OdDbLSComponent
	ODDB_DECLARE_MEMBERS (OdDbLSComponent)

	OdDbLSComponent ()

OdDbLSComponentType	componentType () const

void	setComponentType (OdDbLSComponentType type)

const OdUInt8 *	componentUID () const

OdString	description () const

void	setDescription (const OdString &str)

Public Member Functions inherited from OdDbLSObject
	ODDB_DECLARE_MEMBERS (OdDbLSObject)

	OdDbLSObject ()

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

void	setComponentUID (const OdUInt8 *pUID)

Public Member Functions inherited from OdDbObject
	ODDB_DECLARE_MEMBERS (OdDbObject)

	~OdDbObject ()

void	addRef ()

void	release ()

long	numRefs () const

OdDbObjectId	objectId () const

OdDbHandle	getDbHandle () const

OdDbHandle	handle () const

OdDbObjectId	ownerId () const

virtual void	setOwnerId (OdDbObjectId ownerId)

OdDbDatabase *	database () const

void	createExtensionDictionary ()

OdDbObjectId	extensionDictionary () const

bool	releaseExtensionDictionary ()

OdDbXrecordPtr	createXrecord (const OdString &xrecordName, OdDb::DuplicateRecordCloning style=OdDb::kDrcIgnore)

void	upgradeOpen ()

void	downgradeOpen ()

void	cancel ()

virtual OdResult	subOpen (OdDb::OpenMode mode)

virtual void	subClose ()

OdResult	erase (bool eraseIt=true)

virtual OdResult	subErase (bool erasing)

void	handOverTo (OdDbObject *pNewObject, bool keepXData=true, bool keepExtDict=true)

virtual void	subHandOverTo (OdDbObject *pNewObject)

void	swapIdWith (OdDbObjectId otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	subSwapIdWith (const OdDbObjectId &otherId, bool swapXdata=false, bool swapExtDict=false)

virtual void	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdDb::DuplicateRecordCloning	mergeStyle () const

virtual OdResBufPtr	xData (const OdString &regappName=OdString::kEmpty) const

virtual void	setXData (const OdResBuf *pRb)

bool	isEraseStatusToggled () const

bool	isErased () const

bool	isReadEnabled () const

bool	isWriteEnabled () const

bool	isNotifyEnabled () const

bool	isModified () const

bool	isModifiedXData () const

bool	isModifiedGraphics () const

bool	isNewObject () const

bool	isNotifying () const

bool	isUndoing () const

bool	isReallyClosing () const

bool	isDBRO () const

void	assertReadEnabled () const

void	assertWriteEnabled (bool autoUndo=true, bool recordModified=true)

void	assertNotifyEnabled () const

void	disableUndoRecording (bool disable)

bool	isUndoRecordingDisabled () const

OdDbDwgFiler *	undoFiler ()

virtual void	applyPartialUndo (OdDbDwgFiler pUndoFiler, OdRxClass pClassObj)

void	addReactor (OdDbObjectReactor *pReactor) const

void	removeReactor (OdDbObjectReactor *pReactor) const

virtual void	addPersistentReactor (const OdDbObjectId &objId)

virtual void	removePersistentReactor (const OdDbObjectId &objId)

bool	hasPersistentReactor (const OdDbObjectId &objId) const

OdDbObjectIdArray	getPersistentReactors () const

OdDbObjectReactorArray	getTransientReactors () const

virtual void	recvPropagateModify (const OdDbObject *pSubObj)

virtual void	xmitPropagateModify () const

ODRX_SEALED_VIRTUAL OdDbObjectPtr	deepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdDbObjectPtr	wblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary=true) const ODRX_SEALED

virtual void	appendToOwner (OdDbIdPair &idPair, OdDbObject *pOwnerObject, OdDbIdMapping &ownerIdMap)

void	setOdDbObjectIdsInFlux ()

bool	isOdDbObjectIdsInFlux () const

virtual void	copied (const OdDbObject pObject, const OdDbObject pNewObject)

virtual void	erased (const OdDbObject *pObject, bool erasing=true)

virtual void	goodbye (const OdDbObject *pObject)

virtual void	openedForModify (const OdDbObject *pObject)

virtual void	modified (const OdDbObject *pObject)

virtual void	subObjModified (const OdDbObject pObject, const OdDbObject pSubObj)

virtual void	modifyUndone (const OdDbObject *pObject)

virtual void	modifiedXData (const OdDbObject *pObject)

virtual void	unappended (const OdDbObject *pObject)

virtual void	reappended (const OdDbObject *pObject)

bool	isAProxy () const

virtual void	objectClosed (const OdDbObjectId &objectId)

virtual void	modifiedGraphics (const OdDbObject *pObject)

virtual void	copyFrom (const OdRxObject *pSource)

bool	hasSaveVersionOverride () const

void	setHasSaveVersionOverride (bool hasSaveVersionOverride)

virtual OdDb::DwgVersion	getObjectSaveVersion (const OdDbFiler pFiler, OdDb::MaintReleaseVer pMaintVer=0) const

virtual OdDbObjectPtr	decomposeForSave (OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

virtual OdDbObjectPtr	decomposeForSave (OdDb::SaveType format, OdDb::DwgVersion ver, OdDbObjectId &replaceId, bool &exchangeXData)

void	convertForSave (OdDb::DwgVersion ver)

virtual void	composeForLoad (OdDb::SaveType format, OdDb::DwgVersion version, OdDbAuditInfo *pAuditInfo)

virtual OdGiDrawable *	drawable ()

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

virtual bool	isPersistent () const

virtual OdDbStub *	id () const

ODRX_SEALED_VIRTUAL OdResult	getClassID (void *pClsid) const ODRX_SEALED

void	setGsNode (OdGsCache *pNode)

OdGsCache *	gsNode () const

void	xDataTransformBy (const OdGeMatrix3d &xfm)

bool	hasFields () const

OdDbObjectId	getField (const OdString &fieldName) const

OdDbObjectPtr	getField (const OdString &fieldName, OdDb::OpenMode mode) const

virtual OdDbObjectId	setField (const OdString &fieldName, OdDbField *pField)

virtual OdResult	removeField (OdDbObjectId fieldId)

virtual OdDbObjectId	removeField (const OdString &fieldName)

OdDbObjectId	getFieldDictionary () const

OdDbObjectPtr	getFieldDictionary (OdDb::OpenMode mode) const

virtual OdRxClass *	saveAsClass (OdRxClass *pClass) const

Public Member Functions inherited from OdGiDrawable
	ODRX_DECLARE_MEMBERS (OdGiDrawable)

virtual DrawableType	drawableType () const

ODRX_SEALED_VIRTUAL OdUInt32	setAttributes (OdGiDrawableTraits *pTraits) const ODRX_SEALED

ODRX_SEALED_VIRTUAL bool	worldDraw (OdGiWorldDraw *pWd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL void	viewportDraw (OdGiViewportDraw *pVd) const ODRX_SEALED

ODRX_SEALED_VIRTUAL OdUInt32	viewportDrawLogicalFlags (OdGiViewportDraw *pVd) const ODRX_SEALED

virtual OdResult	getGeomExtents (OdGeExtents3d &extents) const

ODRX_SEALED_VIRTUAL OdUInt32	regenSupportFlags () const ODRX_SEALED

Public Member Functions inherited from OdRxObject
	ODRX_HEAP_OPERATORS ()

	OdRxObject ()

virtual	~OdRxObject ()

virtual OdRxObject *	queryX (const OdRxClass *pClass) const

virtual OdRxObject *	x (const OdRxClass *pClass) const

virtual OdRxClass *	isA () const

bool	isKindOf (const OdRxClass *pClass) const

virtual OdRxObjectPtr	clone () 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 OdRxClass *	desc ()

Protected Member Functions inherited from OdDbObject
	OdDbObject ()

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdDbObjectPtr	subDeepClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

virtual OdDbObjectPtr	subWblockClone (OdDbIdMapping &ownerIdMap, OdDbObject *pOwner, bool bPrimary) const

Protected Member Functions inherited from OdGiDrawable
	OdGiDrawable ()

virtual OdUInt32	subViewportDrawLogicalFlags (OdGiViewportDraw *vd) const

virtual OdUInt32	subRegenSupportFlags () const

Protected Attributes inherited from OdDbObject
OdDbObjectImpl *	m_pImpl

Detailed Description

Dgn Line Style Stroke Pattern Component.

See also: TD_Db <group OdDbLS_Classes>

Definition at line 38 of file DbLSStrokePatternComponent.h.

Member Enumeration Documentation

◆ PhaseMode

enum OdDbLSStrokePatternComponent::PhaseMode

Enumerator
kLSPhaseDistance
kLSPhaseFraction
kLSPhaseCentered

Definition at line 41 of file DbLSStrokePatternComponent.h.

Constructor & Destructor Documentation

◆ OdDbLSStrokePatternComponent()

OdDbLSStrokePatternComponent::OdDbLSStrokePatternComponent ( )

Member Function Documentation

◆ autoPhase()

double OdDbLSStrokePatternComponent::autoPhase ( ) const

Returns phase for fraction phase mode.

Remarks: Null for non-fraction phase modes.

◆ deleteStroke()

void OdDbLSStrokePatternComponent::deleteStroke ( OdUInt32 nStroke )

Removes existing stroke from this stroke pattern component.

Parameters

nStroke [in] Stroke index.

◆ hasIterationLimit()

bool OdDbLSStrokePatternComponent::hasIterationLimit ( ) const

Returns true if iteration limit mode is enabled.

◆ insertStroke() [1/2]

OdDbLSStroke* OdDbLSStrokePatternComponent::insertStroke ( const OdDbLSStroke * pStroke )

Inserts new stroke into this stroke pattern component as copy of existing stroke.

Parameters

pStroke [in] Stroke for clone.

Returns: Returns pointer to newly added stroke which could be used for additional modifications.

◆ insertStroke() [2/2]

OdDbLSStroke* OdDbLSStrokePatternComponent::insertStroke	(	double	fLength = `1.0`,
		double	fStartWidth = `0.0`,
		double	fEndWidth = `0.0`,
		OdDbLSStroke::WidthMode	widthMode = `OdDbLSStroke::kLSNoWidth`,
		OdDbLSStroke::CapMode	capMode = `OdDbLSStroke::kLSCapsClosed`
	)

Inserts new stroke into this stroke pattern component.

Parameters

fLength	[in] Stroke length.
fStartWidth	[in] Stroke start width.
fEndWidth	[in] Stroke end width.
widthMode	[in] Stroke width mode.
capMode	[in] Stroke caps type.

Returns: Returns pointer to newly added stroke which could be used for additional modifications.

◆ isSingleSegment()

bool OdDbLSStrokePatternComponent::isSingleSegment ( ) const

Returns true if single segment mode is enabled.

◆ iterationLimit()

OdInt32 OdDbLSStrokePatternComponent::iterationLimit ( ) const

Returns iteration limit.

◆ numberStrokes()

OdUInt32 OdDbLSStrokePatternComponent::numberStrokes ( ) const

Returns count of strokes in this stroke pattern component.

◆ ODDB_DECLARE_MEMBERS()

OdDbLSStrokePatternComponent::ODDB_DECLARE_MEMBERS ( OdDbLSStrokePatternComponent )

◆ phase()

double OdDbLSStrokePatternComponent::phase ( ) const

Returns phase for distance phase mode.

Remarks: Null for non-distance phase modes.

◆ phaseMode()

PhaseMode OdDbLSStrokePatternComponent::phaseMode ( ) const

Returns current phase mode.

◆ setAutoPhase()

void OdDbLSStrokePatternComponent::setAutoPhase ( double fPhase )

Sets phase for fraction phase mode.

Parameters

fPhase [in] New phase value to set.

◆ setHasIterationLimit()

void OdDbLSStrokePatternComponent::setHasIterationLimit ( bool bSet )

Sets iteration limit mode.

Parameters

bSet	[in] New mode to set.

◆ setIsSingleSegment()

void OdDbLSStrokePatternComponent::setIsSingleSegment ( bool bSet )

Enables single segment mode.

Parameters

bSet	[in] New mode to set.

◆ setIterationLimit()

void OdDbLSStrokePatternComponent::setIterationLimit ( OdInt32 nLimit )

Sets iteration limit.

Parameters

nLimit [in] New limit to set.

◆ setPhase()

void OdDbLSStrokePatternComponent::setPhase ( double fPhase )

Sets phase for distance phase mode.

Parameters

fPhase [in] New phase value to set.

◆ setPhaseMode()

void OdDbLSStrokePatternComponent::setPhaseMode ( PhaseMode mode )

Resets current phase mode.

Parameters

mode	[in] New phase mode to set.

◆ stroke()

OdDbLSStroke* OdDbLSStrokePatternComponent::stroke ( OdUInt32 nStroke ) const

Returns stroke pointer from this stroke pattern component.

Parameters

nStroke [in] Stroke index.

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

DbLSStrokePatternComponent.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PhaseMode

Constructor & Destructor Documentation

◆ OdDbLSStrokePatternComponent()

Member Function Documentation

◆ autoPhase()

◆ deleteStroke()

◆ hasIterationLimit()

◆ insertStroke() [1/2]

◆ insertStroke() [2/2]

◆ isSingleSegment()

◆ iterationLimit()

◆ numberStrokes()

◆ ODDB_DECLARE_MEMBERS()

◆ phase()

◆ phaseMode()

◆ setAutoPhase()

◆ setHasIterationLimit()

◆ setIsSingleSegment()

◆ setIterationLimit()

◆ setPhase()

◆ setPhaseMode()

◆ stroke()