#include <DbLayerTableRecord.h>

Inheritance diagram for OdDbLayerTableRecord:

Public Types
typedef OdDbLayerTable	TableType

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 (OdDbLayerTableRecord)

	OdDbLayerTableRecord ()

bool	isFrozen () const

void	setIsFrozen (bool bStatus)

bool	isOff () const

void	setIsOff (bool bStatus)

bool	VPDFLT () const

void	setVPDFLT (bool bStatus)

bool	isLocked () const

void	setIsLocked (bool bStatus)

bool	isPlottable () const

void	setIsPlottable (bool bStatus)

bool	isHidden () const

void	setIsHidden (bool bStatus)

bool	isReconciled () const

void	setIsReconciled (bool bStatus=true)

OdCmTransparency	transparency () const

OdCmTransparency	transparency (const OdDbObjectId &idViewport, bool *pIsOverride=0) const

OdResult	setTransparency (const OdCmTransparency &cmTransparency)

void	setTransparency (const OdCmTransparency &cmTransparency, const OdDbObjectId &idViewport)

OdCmColor	color () const

OdCmColor	color (const OdDbObjectId &viewportId, bool *pIsOverride=0) const

void	setColor (const OdCmColor &cmColor)

void	setColor (const OdCmColor &cmColor, const OdDbObjectId &idViewport)

OdInt16	colorIndex () const

void	setColorIndex (OdInt16 idxColor)

OdDb::LineWeight	lineWeight () const

OdDb::LineWeight	lineWeight (const OdDbObjectId &idViewport, bool *pIsOverride=0) const

void	setLineWeight (OdDb::LineWeight kLnWtEnum)

void	setLineWeight (OdDb::LineWeight kLnWtEnum, const OdDbObjectId &idViewport)

OdDbObjectId	linetypeObjectId () const

OdDbObjectId	linetypeObjectId (const OdDbObjectId &idViewport, bool *pIsOverride=0) const

void	setLinetypeObjectId (OdDbObjectId idLinetype)

void	setLinetypeObjectId (const OdDbObjectId &idLinetype, const OdDbObjectId &idViewport)

OdDbObjectId	materialId () const

void	setMaterialId (OdDbObjectId idMaterial)

OdString	plotStyleName () const

OdString	plotStyleName (const OdDbObjectId &idViewport, bool *pIsOverride=0) const

OdDbObjectId	plotStyleNameId () const

OdDbObjectId	plotStyleNameId (const OdDbObjectId &idViewport, bool *pIsOverride=0) const

OdResult	setPlotStyleName (const OdString &sPlotStyleName)

void	setPlotStyleName (const OdString &sPlotStyleName, const OdDbObjectId &idViewport)

void	setPlotStyleName (OdDbObjectId idPlotStyle)

void	setPlotStyleName (const OdDbObjectId &idPlotStyle, const OdDbObjectId &idViewport)

OdString	description () const

void	setDescription (const OdString &sDescription)

bool	isInUse () const

virtual OdResult	dwgInFields (OdDbDwgFiler *pFiler)

virtual void	dwgOutFields (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfInFields (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields (OdDbDxfFiler *pFiler) const

virtual OdResult	dxfInFields_R12 (OdDbDxfFiler *pFiler)

virtual void	dxfOutFields_R12 (OdDbDxfFiler *pFiler) const

virtual OdResult	subGetClassID (void *pClsid) const

virtual OdResult	subErase (bool erasing)

virtual OdUInt32	subSetAttributes (OdGiDrawableTraits *pTraits) const

virtual bool	subWorldDraw (OdGiWorldDraw *pWd) const

virtual void	subViewportDraw (OdGiViewportDraw *pVd) const

OdGiDrawable *	drawable ()

void	removeAllOverrides ()

void	removeColorOverride (const OdDbObjectId &idViewport)

void	removeLinetypeOverride (const OdDbObjectId &idViewport)

void	removeLineWeightOverride (const OdDbObjectId &idViewport)

void	removePlotStyleOverride (const OdDbObjectId &idViewport)

void	removeTransparencyOverride (const OdDbObjectId &idViewport)

void	removeViewportOverrides (const OdDbObjectId &idViewport)

bool	hasOverrides (const OdDbObjectId &idViewport) const

bool	hasAnyOverrides () const

Public Member Functions inherited from OdDbSymbolTableRecord
	ODDB_DECLARE_MEMBERS (OdDbSymbolTableRecord)

	OdDbSymbolTableRecord ()

virtual OdString	getName () const

virtual void	setName (const OdString &sName)

bool	isDependent () const

bool	isResolved () const

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

virtual void	copyFrom (const OdRxObject *pSource)

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

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)

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	audit (OdDbAuditInfo *pAuditInfo)

void	dwgIn (OdDbDwgFiler *pFiler)

void	dwgOut (OdDbDwgFiler *pFiler) const

virtual OdResult	dxfIn (OdDbDxfFiler *pFiler)

virtual void	dxfOut (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

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)

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 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

Static Public Member Functions
static bool	isHidden (const OdDbObjectId &idLayer)

static bool	isReconciled (const OdDbObjectId &idLayer)

Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr	cast (const OdRxObject *pointer)

static OdRxClass *	desc ()

Additional Inherited Members
Protected Member Functions inherited from OdDbObject
	OdDbObject ()

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

This class implements the layer record object, which represents a layer in the database. This class inherits the base functionality of named records.

See also: TD_Db; <link db_layer_sample_table.html, Example of Working with the Layer Table Object>

See also: <link db_layer.html, Working with Layers>

OdDbLayerTable class

Definition at line 56 of file DbLayerTableRecord.h.

Member Typedef Documentation

◆ TableType

typedef OdDbLayerTable OdDbLayerTableRecord::TableType

Definition at line 70 of file DbLayerTableRecord.h.

Constructor & Destructor Documentation

◆ OdDbLayerTableRecord()

OdDbLayerTableRecord::OdDbLayerTableRecord ( )

Builds an instance of the layer record object.

Remarks: Use the static pseudo-constructor instead it. See: <link db_layer_add_name.html, Adding and Naming Layers>

Member Function Documentation

◆ color() [1/2]

OdCmColor OdDbLayerTableRecord::color ( ) const

Returns the color for the layer record object (DXF 62). This color is used when the Color property of an entity belonged to the layer is set to byLayer value. The actual color value can depend on the viewport in which the entity is rendered.

Remarks: The same layer can have different colors in different viewports. Therefore this method is overdriven. The method without arguments returns the own color of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setColor() method

◆ color() [2/2]

OdCmColor OdDbLayerTableRecord::color	(	const OdDbObjectId &	viewportId,
		bool *	pIsOverride = `0`
	)		const

Returns the color for the layer record object (DXF 62). This color is used when the Color property of an entity belonged to the layer is set to byLayer value. The actual color value can depend on the viewport in which the entity is rendered.

Parameters

viewportId	[in] Object ID of the viewport for which the color value should be obtained.
pIsOverride	[out] Pointer to the Boolean variable in which this method saves the result: True if it is the specific color previously specified for the viewport, or False if it is own color and the layer does not store a color for the specified viewport.

Remarks: The same layer can have different colors in different viewports. Therefore this method is overdriven. The method with two arguments returns the specific color specified for the viewport or own color if the specific color is not specified for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setColor() method

◆ colorIndex()

OdInt16 OdDbLayerTableRecord::colorIndex ( ) const

Returns the color index for the layer record object (DXF 62). When the color method is set to byColor, this method returns an equivalent color index.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setColorIndex() method

◆ description()

OdString OdDbLayerTableRecord::description ( ) const

Returns the description for the layer record object.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setDescription() method

◆ drawable()

OdGiDrawable* OdDbLayerTableRecord::drawable ( )

virtual

Returns a pointer to the OdGiDrawable for the object. If the object doesn't have an associated OdGiDrawable object, this function returns NULL.

Reimplemented from OdDbObject.

◆ dwgInFields()

virtual OdResult OdDbLayerTableRecord::dwgInFields ( OdDbDwgFiler * pFiler )

virtual

Reads the .dwg file data of this object.

Parameters

pFiler [in] Filer object from which data are read.

Returns: Returns the filer status.

This function is called by dwgIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dwgInFields(pFiler) returned. 4) Call the OdDbDwgFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbSymbolTableRecord.

◆ dwgOutFields()

virtual void OdDbLayerTableRecord::dwgOutFields ( OdDbDwgFiler * pFiler ) const

virtual

Writes the .dwg file data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are written.

Remarks

This function is called by dwgIn() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dwgOutFields(pFiler). 3) Call the OdDbDwgFiler(pFiler) methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbSymbolTableRecord.

◆ dxfInFields()

virtual OdResult OdDbLayerTableRecord::dxfInFields ( OdDbDxfFiler * pFiler )

virtual

Reads the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer from which data are read.

Returns: Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dwgInFields(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfInFields(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbSymbolTableRecord.

◆ dxfInFields_R12()

virtual OdResult OdDbLayerTableRecord::dxfInFields_R12 ( OdDbDxfFiler * pFiler )

virtual

Reads the DXF R12 format data of this object.

Parameters

pFiler [in] Pointer to the filer from which data are to be read.

Returns: Returns the filer status.

This function is called by dxfIn() to allow the object to read its data.

When overriding this function:

1) Call assertWriteEnabled(). 2) Call the parent class's dxfInFields_R12(pFiler). 3) If it returns eOK, continue; otherwise return whatever the parent's dxfOutFields_R12(pFiler) returned. 4) Call the OdDbDxfFiler(pFiler) methods to read each of the object's data items in the order they were written. 5) Return pFiler->filerStatus().

Reimplemented from OdDbObject.

◆ dxfOutFields()

virtual void OdDbLayerTableRecord::dxfOutFields ( OdDbDxfFiler * pFiler ) const

virtual

Writes the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are to be written.

Remarks

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 4) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbSymbolTableRecord.

◆ dxfOutFields_R12()

virtual void OdDbLayerTableRecord::dxfOutFields_R12 ( OdDbDxfFiler * pFiler ) const

virtual

Writes the DXF data of this object.

Parameters

pFiler [in] Pointer to the filer to which data are to be written.

Returns: Returns the filer status.

This function is called by dxfOut() to allow the object to write its data.

When overriding this function:

1) Call assertReadEnabled(). 2) Call the parent class's dxfOutFields(pFiler). 3) Use pFiler to call the OdDbDxfFiler methods to write each of the object's data items in the order they were written.

Reimplemented from OdDbSymbolTableRecord.

◆ hasAnyOverrides()

bool OdDbLayerTableRecord::hasAnyOverrides ( ) const

◆ hasOverrides()

bool OdDbLayerTableRecord::hasOverrides ( const OdDbObjectId & idViewport ) const

◆ isFrozen()

bool OdDbLayerTableRecord::isFrozen ( ) const

Determines whether the layer record object is invisible and accessible for regenerating, printing, selecting, and editing (DXF 70, bit 0x01) and returns True if the layer is frozen or False if the layer is thawed.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsFrozen() method

◆ isHidden() [1/2]

bool OdDbLayerTableRecord::isHidden ( ) const

Determines whether the layer record object is displayed for the host application and returns True if the layer is hidden or False if the layer is shown.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsHidden() method

◆ isHidden() [2/2]

static bool OdDbLayerTableRecord::isHidden ( const OdDbObjectId & idLayer )

static

Determines whether the layer record object is displayed for the host application and returns True if the layer is hidden or False if the layer is shown.

Remarks: The static isHidden() method checks the Hidden status for the specified layer ID.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsHidden() method

◆ isInUse()

bool OdDbLayerTableRecord::isInUse ( ) const

Determines whether the layer record object is in-use when the generateUsageData() method
is called and returns True if the layer is in-use, or False if the layer is not use.

Remarks: Returns true when the generateUsageData() of the layer table object has not been called or this layer record object is not database resident.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTable::generateUsageData() method

◆ isLocked()

bool OdDbLayerTableRecord::isLocked ( ) const

Determines whether the layer record object is accessible for selecting and editing (DXF 70, bit 0x04) and returns True if the layer is locked or False if the layer is editable.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsLocked() method

◆ isOff()

bool OdDbLayerTableRecord::isOff ( ) const

Determines whether the layer record object is invisible (DXF 62, negative is off, positive is on) and returns True if the layer is off (invisible) or False if the layer is on (visible).

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsOff() method

◆ isPlottable()

bool OdDbLayerTableRecord::isPlottable ( ) const

Determines whether the layer record object is accessible for printing (DXF 290) and returns True if the layer is plottable or False if the layer is unplottable.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsPlottable() method

◆ isReconciled() [1/2]

bool OdDbLayerTableRecord::isReconciled ( ) const

Determines whether the layer record object is reconciled with another object and returns True if the layer is reconciled, or False if the layer is not reconciled.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsReconciled() method

◆ isReconciled() [2/2]

static bool OdDbLayerTableRecord::isReconciled ( const OdDbObjectId & idLayer )

static

Determines whether the layer record object is reconciled with another object and returns True if the layer is reconciled, or False if the layer is not reconciled.

Remarks: The static isReconciled() method checks the Reconcile status for the specified layer ID.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::setIsReconciled() method

◆ linetypeObjectId() [1/2]

OdDbObjectId OdDbLayerTableRecord::linetypeObjectId ( ) const

Returns the ID of the linetype record object associated with the layer record object (DXF 6), or OdDb::kNULL when the layer is not associated with linetype. This linetype is used when the Linetype property of an entity belonged to this layer is set to ByLayer value. The actual linetype can depend on the viewport in which the entity is rendered.

Remarks: The same layer can have different linetypes in different viewports. Therefore this method is overdriven. The method without arguments returns the own linetype of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setLinetypeObjectId() method

◆ linetypeObjectId() [2/2]

OdDbObjectId OdDbLayerTableRecord::linetypeObjectId	(	const OdDbObjectId &	idViewport,
		bool *	pIsOverride = `0`
	)		const

Returns the ID of the linetype record object associated with the layer record object (DXF 6), or OdDb::kNULL when the layer is not associated with linetype. This linetype is used when the Linetype property of an entity belonged to this layer is set to ByLayer value. The actual linetype can depend on the viewport in which the entity is rendered.

Parameters

idViewport	[in] Object ID of the viewport for which the linetype ID should be obtained.
pIsOverride	[out] Pointer to the Boolean variable in which this method saves the result: True if it is the specific linetype previously specified for the viewport, or False if it is own linetype and the layer does not store a linetype for the specified viewport.

Remarks: The same layer can have different linetypes in different viewports. Therefore this method is overdriven. The method with two arguments returns the specific linetype specified for the viewport or own linetype if the specific linetype is not specified for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setLinetypeObjectId() method

◆ lineWeight() [1/2]

OdDb::LineWeight OdDbLayerTableRecord::lineWeight ( ) const

Returns the lineweight of the layer record object (DXF 370). This lineweight is used when
the Lineweight property of an entity belonged to this layer is set to ByLayer value. The actual lineweight can depend on the viewport in which the entity is rendered.

Remarks: The same layer can have different lineweights in different viewports. Therefore this method is overdriven. The method without arguments returns the own lineweight of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setLineWeight() method

◆ lineWeight() [2/2]

OdDb::LineWeight OdDbLayerTableRecord::lineWeight	(	const OdDbObjectId &	idViewport,
		bool *	pIsOverride = `0`
	)		const

Returns the lineweight of the layer record object (DXF 370). This lineweight is used when
the Lineweight property of an entity belonged to this layer is set to ByLayer value. The actual lineweight can depend on the viewport in which the entity is rendered.

Parameters

idViewport	[in] Object ID of the viewport for which the lineweight should be obtained.
pIsOverride	[out] Pointer to the Boolean variable in which this method saves the result: True if it is the specific lineweight previously specified for the viewport, or False if it is own lineweight and the layer does not store a lineweight for the specified viewport.

Remarks: The same layer can have different lineweights in different viewports. Therefore this method is overdriven. The method with two arguments returns the specific lineweight specified for the viewport or own lineweight if the specific lineweight is not specified for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setLineWeight() method

◆ materialId()

OdDbObjectId OdDbLayerTableRecord::materialId ( ) const

Returns the ID of the material object associated with the layer record object (DXF 347) or OdDb::kNULL when the layer is not associated with material. This material is used when the Material property of an entity belonged to this layer is set to ByLayer value.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setMaterialId() method

◆ ODDB_DECLARE_MEMBERS()

OdDbLayerTableRecord::ODDB_DECLARE_MEMBERS ( OdDbLayerTableRecord )

◆ plotStyleName() [1/2]

OdString OdDbLayerTableRecord::plotStyleName ( ) const

Retuns the name of the plot style associated with the layer record object (DXF 390). This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The actual plot style can depend on the viewport in which the entity is rendered.

See also: <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::plotStyleNameId(), OdDbLayerTableRecord::setPlotStyleName() methods

◆ plotStyleName() [2/2]

OdString OdDbLayerTableRecord::plotStyleName	(	const OdDbObjectId &	idViewport,
		bool *	pIsOverride = `0`
	)		const

Retuns the name of the plot style associated with the layer record object (DXF 390). This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The actual plot style can depend on the viewport in which the entity is rendered.

Parameters

idViewport	[in] Object ID of the viewport for which the plot style ID should be obtained.
pIsOverride	[out] Pointer to the Boolean variable in which this method saves the result: True if it is the specific plot style previously specified for the viewport, or False if it is own plot style and the layer does not store a plot style for the specified viewport.

See also: <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::plotStyleNameId(), OdDbLayerTableRecord::setPlotStyleName() methods

◆ plotStyleNameId() [1/2]

OdDbObjectId OdDbLayerTableRecord::plotStyleNameId ( ) const

Returns the ID of the plot style object associated with the layer record object (DXF 390) or OdDb::kNULL when the layer is not associated with plot style. This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The actual plot
style can depend on the viewport in which the entity is rendered.

See also: <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::plotStyleName(), OdDbLayerTableRecord::setPlotStyleName() methods

◆ plotStyleNameId() [2/2]

OdDbObjectId OdDbLayerTableRecord::plotStyleNameId	(	const OdDbObjectId &	idViewport,
		bool *	pIsOverride = `0`
	)		const

Returns the ID of the plot style object associated with the layer record object (DXF 390) or OdDb::kNULL when the layer is not associated with plot style. This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The actual plot
style can depend on the viewport in which the entity is rendered.

Parameters

idViewport	[in] Object ID of the viewport for which the plot style ID should be obtained.
pIsOverride	[out] Pointer to the Boolean variable in which this method saves the result: True if it is the specific plot style previously specified for the viewport, or False if it is own plot style and the layer does not store a plot style for the specified viewport.

See also: <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::plotStyleName(), OdDbLayerTableRecord::setPlotStyleName() methods

◆ removeAllOverrides()

void OdDbLayerTableRecord::removeAllOverrides ( )

◆ removeColorOverride()

void OdDbLayerTableRecord::removeColorOverride ( const OdDbObjectId & idViewport )

◆ removeLinetypeOverride()

void OdDbLayerTableRecord::removeLinetypeOverride ( const OdDbObjectId & idViewport )

◆ removeLineWeightOverride()

void OdDbLayerTableRecord::removeLineWeightOverride ( const OdDbObjectId & idViewport )

◆ removePlotStyleOverride()

void OdDbLayerTableRecord::removePlotStyleOverride ( const OdDbObjectId & idViewport )

◆ removeTransparencyOverride()

void OdDbLayerTableRecord::removeTransparencyOverride ( const OdDbObjectId & idViewport )

◆ removeViewportOverrides()

void OdDbLayerTableRecord::removeViewportOverrides ( const OdDbObjectId & idViewport )

◆ setColor() [1/2]

void OdDbLayerTableRecord::setColor ( const OdCmColor & cmColor )

Sets the color for the layer record object (DXF 62). This color is used when the Color property of an entity belonged to this layer is set to byLayer value. The initial value is Foreground (index 7) by default. The same entity can be rendered using different colors in different viewports.

Parameters

cmColor [in] Reference to the color instance to be set.

Remarks: The same layer can have different colors in different viewports. Therefore this method is overdriven. The method with one argument sets the own color of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::color() method

◆ setColor() [2/2]

void OdDbLayerTableRecord::setColor	(	const OdCmColor &	cmColor,
		const OdDbObjectId &	idViewport
	)

Sets the color for the layer record object (DXF 62). This color is used when the Color property of an entity belonged to this layer is set to byLayer value. The initial value is Foreground (index 7) by default. The same entity can be rendered using different colors in different viewports.

Parameters

cmColor	[in] Reference to the color instance to be set.
idViewport	[in] Object ID of the viewport in which the layer must have the specific color.

Remarks: The same layer can have different colors in different viewports. Therefore this method is overdriven. The method with two arguments sets the specific color for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::color() method

◆ setColorIndex()

void OdDbLayerTableRecord::setColorIndex ( OdInt16 idxColor )

Sets the color index for the layer record object (DXF 62) as an Integer value. The initial
value is 7 (Foreground) by default.

Parameters

idxColor [in] Color index in range 1 to 255.

Remarks: When the index outs the range 1 to 255, this method generates an exception. This method sets
the color method to byACI.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::colorIndex() method

◆ setDescription()

void OdDbLayerTableRecord::setDescription ( const OdString & sDescription )

Sets the description for the layer record object as a String value up to 255 letters length. The initial value is an empty string.

Parameters

sDescription [in] Description as a String value.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::description() method

◆ setIsFrozen()

void OdDbLayerTableRecord::setIsFrozen ( bool bStatus )

Sets the Freeze status as a Boolean value (DXF 70, bit 0x01). The initial value is False (Thawed) by default.

Parameters

bStatus [in] True - to freeze the layer, or False - to thaw the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::isFrozen() method

◆ setIsHidden()

void OdDbLayerTableRecord::setIsHidden ( bool bStatus )

Sets the Hidden status as a Boolean value. The initial value is False (Shown) by default.

Parameters

bStatus [in] True - to hide the layer, or False - to show the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::isHidden() method

◆ setIsLocked()

void OdDbLayerTableRecord::setIsLocked ( bool bStatus )

Sets the Lock status as a Boolean value (DXF 70, bit 0x04). The initial value is False (Editable) by default.

Parameters

bStatus [in] True - to lock the layer, or False - to unlock the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::isLocked() method

◆ setIsOff()

void OdDbLayerTableRecord::setIsOff ( bool bStatus )

Sets the On-Off status as a Boolean value (DXF 62). The initial value is False (Visible) by default.

Parameters

bStatus [in] True - to make the layer invisible (off), or False - to make the layer visible (on).

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::isOff() method

◆ setIsPlottable()

void OdDbLayerTableRecord::setIsPlottable ( bool bStatus )

Sets the Plot status as a Boolean value (DXF 290). The initial value is True (Plottable) by default.

Parameters

bStatus [in] True - to make the layer plottable, or False - to make the layer no plottable.

Remarks: Some layers cannot be set to plottable; e.g., the "Defpoints" Layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::isPlottable() method

◆ setIsReconciled()

void OdDbLayerTableRecord::setIsReconciled ( bool bStatus = true )

Sets the Reconcile status as a Boolean value.

Parameters

bStatus [in] True - to set the Reconcile status, or False - to clear the Reconcile status.

See also: <link db_layer_status.html, Status of Layers>

OdDbLayerTableRecord::isReconciled() method

◆ setLinetypeObjectId() [1/2]

void OdDbLayerTableRecord::setLinetypeObjectId	(	const OdDbObjectId &	idLinetype,
		const OdDbObjectId &	idViewport
	)

Sets the ID of the linetype record object for the layer record object (DXF 6) as an ObDbObjectId instance. This method associates layer and linetype. This linetype is used when the Linetype property of an entity belonged to this layer is set to ByLayer value. The initial value associates the layer with the "Continuous" linetype by default. The same entity can be rendered using different linetypes in different viewports.

Parameters

idLinetype	[in] Object ID of the linetype record object to associate it with the layer, or OdDb::kNull to disassociate the layer and linetype.
idViewport	[in] Object ID of the viewport in which the layer must have the specific linetype.

Remarks: The same layer can have different linetypes in different viewports. Therefore this method is overdriven. The method with two arguments sets the specific linetype for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::linetypeObjectId() method

◆ setLinetypeObjectId() [2/2]

void OdDbLayerTableRecord::setLinetypeObjectId ( OdDbObjectId idLinetype )

Sets the ID of the linetype record object for the layer record object (DXF 6) as an ObDbObjectId instance. This method associates layer and linetype. This linetype is used when the Linetype property of an entity belonged to this layer is set to ByLayer value. The initial value associates the layer with the "Continuous" linetype by default. The same entity can be rendered using different linetypes in different viewports.

Parameters

idLinetype [in] Object ID of the linetype record object to associate it with the layer, or OdDb::kNull to disassociate the layer and linetype.

Remarks: The same layer can have different linetypes in different viewports. Therefore this method is overdriven. The method with one argument sets the own linetype of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::linetypeObjectId() method

◆ setLineWeight() [1/2]

void OdDbLayerTableRecord::setLineWeight ( OdDb::LineWeight kLnWtEnum )

Sets the lineweight for the layer record object (DXF 370). This lineweight is used when the Lineweight property of an entity belonged to this layer is set to ByLayer value. The initial value is kLnWtByLwDefault by default. The same entity can be rendered using different lineweights in different viewports.

Parameters

kLnWtEnum [in] Lineweight (value of the enumerator).

Remarks: The same layer can have different lineweights in different viewports. Therefore this method is overdriven. The method with one argument sets the own lineweight of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::lineWeight() method

◆ setLineWeight() [2/2]

void OdDbLayerTableRecord::setLineWeight	(	OdDb::LineWeight	kLnWtEnum,
		const OdDbObjectId &	idViewport
	)

Sets the lineweight for the layer record object (DXF 370). This lineweight is used when the Lineweight property of an entity belonged to this layer is set to ByLayer value. The initial value is kLnWtByLwDefault by default. The same entity can be rendered using different lineweights in different viewports.

Parameters

kLnWtEnum	[in] Lineweight (value of the enumerator).
idViewport	[in] Object ID of the viewport in which the layer must have the specific lineweight.

Remarks: The same layer can have different lineweights in different viewports. Therefore this method is overdriven. The method with two arguments sets the specific lineweight for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::lineWeight() method

◆ setMaterialId()

void OdDbLayerTableRecord::setMaterialId ( OdDbObjectId idMaterial )

Sets the ID of the material object for the layer record object (DXF 347) as an ObDbObjectId instance. This method associates layer and material. The initial value associates the layer with the "Global" material by default.

Parameters

idMaterial [in] Object ID of the material object to associate it with the layer, or OdDb::kNull to disassociate the layer and material.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::materialId() method

◆ setPlotStyleName() [1/4]

void OdDbLayerTableRecord::setPlotStyleName	(	const OdDbObjectId &	idPlotStyle,
		const OdDbObjectId &	idViewport
	)

Sets the ID of the place holder object for the layer record object (DXF 390). This method associates layer and plot style. The ID is an ObDbObjectId instance. This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The same entity can be rendered using different plot styles in different viewports.

Parameters

idPlotStyle	[in] Object ID of the place holder object to associate it with the layer, or OdDb::kNull to disassociate the layer and plot style.
idViewport	[in] Object ID of the viewport in which the layer must have the specific plot style.

Remarks: The same layer can have different plot styles in different viewports. Therefore this method is overdriven. The method with two arguments sets the specific plot style for the viewport using the plot style ID.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

◆ setPlotStyleName() [2/4]

OdResult OdDbLayerTableRecord::setPlotStyleName ( const OdString & sPlotStyleName )

Sets the name of the place holder object for the layer record object (DXF 390). This method associates layer and plot style. The name is an OdString instance. This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The same entity can be rendered using different plot styles in different viewports.

Parameters

sPlotStyleName [in] Plot style name as non-empty string.

Remarks: The same layer can have different plot styles in different viewports. Therefore this method is overdriven. The method with one argument sets the own plot style of the layer using the plot style name.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

◆ setPlotStyleName() [3/4]

void OdDbLayerTableRecord::setPlotStyleName	(	const OdString &	sPlotStyleName,
		const OdDbObjectId &	idViewport
	)

Sets the name of the place holder object for the layer record object (DXF 390). This method associates layer and plot style. The ID is an ObDbObjectId instance, the name is an OdString instance. This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The same entity can be rendered using different plot styles in different viewports.

Parameters

sPlotStyleName	[in] Plot style name as non-empty string.
idViewport	[in] Object ID of the viewport in which the layer must have the specific plot style.

Remarks: The same layer can have different plot styles in different viewports. Therefore this method is overdriven. The method with two arguments sets the specific plot style for the viewport using the plot style name.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

◆ setPlotStyleName() [4/4]

void OdDbLayerTableRecord::setPlotStyleName ( OdDbObjectId idPlotStyle )

Sets the ID of the place holder object for the layer record object (DXF 390). This method associates layer and plot style. The ID is an ObDbObjectId instance. This plot style is used when the PlotStyle property of an entity belonged to this layer is set to ByLayer value. The same entity can be rendered using different plot styles in different viewports.

Parameters

idPlotStyle [in] Object ID of the place holder object to associate it with the layer, or OdDb::kNull to disassociate the layer and plot style.

Remarks: The same layer can have different plot styles in different viewports. Therefore this method is overdriven. The method with one argument sets the own plot style of the layer using the plot style ID.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

◆ setTransparency() [1/2]

OdResult OdDbLayerTableRecord::setTransparency ( const OdCmTransparency & cmTransparency )

Sets the transparency for the layer record object (as XData) and returns eOk if successful. This transparency is used when the Transparency property of an entity belonged to this layer is set to byLayer value. The initial value is byAlpha = 100% value (solid) by default. The same entity can be rendered using different transparencies in different viewports.

Parameters

cmTransparency [in] Reference to the transparency instance to be set as an Alpha-value in range 1 to 255.

Remarks: The same layer can have different transparencies in different viewports. Therefore this method is overdriven. The method with one argument sets the own transparency of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::transparency() method

◆ setTransparency() [2/2]

void OdDbLayerTableRecord::setTransparency	(	const OdCmTransparency &	cmTransparency,
		const OdDbObjectId &	idViewport
	)

Sets the transparency for the layer record object (as XData). This transparency is used when the Transparency property of an entity belonged to this layer is set to byLayer value. The initial value is byAlpha = 100% value (solid) by default. The same entity can be rendered using different transparencies in different viewports.

Parameters

cmTransparency	[in] Reference to the transparency instance to be set as an Alpha-value in range 1 to 255.
idViewport	[in] Object ID of the viewport in which the layer must have the specific transparency.

Remarks: The same layer can have different transparencies in different viewports. Therefore this method is overdriven. The method with two arguments sets the specific transparency for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::transparency() method

◆ setVPDFLT()

void OdDbLayerTableRecord::setVPDFLT ( bool bStatus )

Sets the Freeze status in new viewports for the layer as a Boolean value (DXF 70, bit 0x02).

Parameters

bStatus [in] True - to specify the frozen layers for new viewports, or False - to specify the thawed layers for new viewports.

See also: OdDbLayerTableRecord::VPDFLT() method

◆ subErase()

virtual OdResult OdDbLayerTableRecord::subErase ( bool erasing )

virtual

Called as the first operation as this object is being erased or unerased.

Parameters

erasing [in] A copy of the erasing argument passed to erase().

Remarks: This function is notified just before the current object is to be erased, giving this function the ability to cancel the erase.

Returns eOk if and only if erase() is to continue.

When overriding this function:

1) If the OdDbObject's state is incorrect, return something other than eOk.

2) If the parent class's subErase() returns anything other than eOk, immediately return it.

3) If other actions are required before erase, do them.

4) Return eOk.

If you must make changes to this object's state, either make them after step 2, or roll them back if step 2 returns other than eOk.

The default implementation of this function does nothing but return eOk. This function can be overridden in custom classes.

Reimplemented from OdDbSymbolTableRecord.

◆ subGetClassID()

virtual OdResult OdDbLayerTableRecord::subGetClassID ( void * pClsid ) const

virtual

Reimplemented from OdDbObject.

◆ subSetAttributes()

virtual OdUInt32 OdDbLayerTableRecord::subSetAttributes ( OdGiDrawableTraits * pTraits ) const

virtual

Sets the values of this object's subentity traits, and returns with the calling object's subentity traits.

Parameters

pTraits [in] Pointer to the OdGiDrawableTraits object to be set.

Remarks: When overriding subSetAttributes(), you must OR (|) the return value of <base class>::subSetAttributes(pTraits) with any flags you add.

A derived class may not remove flags for any reason.

The default implementation does nothing but returns kDrawableNone. This function can be overridden in custom classes.

Reimplemented from OdDbObject.

◆ subViewportDraw()

virtual void OdDbLayerTableRecord::subViewportDraw ( OdGiViewportDraw * pVd ) const

virtual

Reimplemented from OdDbObject.

◆ subWorldDraw()

virtual bool OdDbLayerTableRecord::subWorldDraw ( OdGiWorldDraw * pWd ) const

virtual

Reimplemented from OdDbObject.

◆ transparency() [1/2]

OdCmTransparency OdDbLayerTableRecord::transparency ( ) const

Returns the transparency for the layer record object (as XData). This transparency is used when the Transparency property of an entity belonged to the layer is set to the byLayer value. The actual transparency value can depend on the viewport in which the entity is rendered.

Remarks: The same layer can have different transparencies in different viewports. Therefore this method is overdriven. The method without arguments returns the own transparency of the layer.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setTransparency() method

◆ transparency() [2/2]

OdCmTransparency OdDbLayerTableRecord::transparency	(	const OdDbObjectId &	idViewport,
		bool *	pIsOverride = `0`
	)		const

Returns the transparency for the layer record object (as XData). This transparency is used when the Transparency property of an entity belonged to the layer is set to the byLayer value. The actual transparency value can depend on the viewport in which the entity is rendered.

Parameters

idViewport	[in] Object ID of the viewport for which the transparency value should be obtained.
pIsOverride	[out] Pointer to the Boolean variable in which this method saves the result: True if it is the specific transparency previously specified for the viewport, or False if it is own transparency and the layer does not store a transparency for the specified viewport.

Remarks: The same layer can have different transparencies in different viewports. Therefore this method is overdriven. The method with two arguments returns the specific transparency specified for the viewport or own transparency if the specific transparency is not specified for the viewport.

See also: <link db_layer_sample_record.html, Example of Working with the Layer Record Object>; <link db_layer_properties.html, Specific Properties of Layers>

OdDbLayerTableRecord::setTransparency() method

◆ VPDFLT()

bool OdDbLayerTableRecord::VPDFLT ( ) const

Returns true if and only if the layer is frozen in new viewports (DXF 70, bit 0x02).

See also: OdDbLayerTableRecord::setVPDFLT() method

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

DbLayerTableRecord.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ TableType

Constructor & Destructor Documentation

◆ OdDbLayerTableRecord()

Member Function Documentation

◆ color() [1/2]

◆ color() [2/2]

◆ colorIndex()

◆ description()

◆ drawable()

◆ dwgInFields()

◆ dwgOutFields()

◆ dxfInFields()

◆ dxfInFields_R12()

◆ dxfOutFields()

◆ dxfOutFields_R12()

◆ hasAnyOverrides()

◆ hasOverrides()

◆ isFrozen()

◆ isHidden() [1/2]

◆ isHidden() [2/2]

◆ isInUse()

◆ isLocked()

◆ isOff()

◆ isPlottable()

◆ isReconciled() [1/2]

◆ isReconciled() [2/2]

◆ linetypeObjectId() [1/2]

◆ linetypeObjectId() [2/2]

◆ lineWeight() [1/2]

◆ lineWeight() [2/2]

◆ materialId()

◆ ODDB_DECLARE_MEMBERS()

◆ plotStyleName() [1/2]

◆ plotStyleName() [2/2]

◆ plotStyleNameId() [1/2]

◆ plotStyleNameId() [2/2]

◆ removeAllOverrides()

◆ removeColorOverride()

◆ removeLinetypeOverride()

◆ removeLineWeightOverride()

◆ removePlotStyleOverride()

◆ removeTransparencyOverride()

◆ removeViewportOverrides()

◆ setColor() [1/2]

◆ setColor() [2/2]

◆ setColorIndex()

◆ setDescription()

◆ setIsFrozen()

◆ setIsHidden()

◆ setIsLocked()

◆ setIsOff()

◆ setIsPlottable()

◆ setIsReconciled()

◆ setLinetypeObjectId() [1/2]

◆ setLinetypeObjectId() [2/2]

◆ setLineWeight() [1/2]

◆ setLineWeight() [2/2]

◆ setMaterialId()

◆ setPlotStyleName() [1/4]

◆ setPlotStyleName() [2/4]

◆ setPlotStyleName() [3/4]

◆ setPlotStyleName() [4/4]

◆ setTransparency() [1/2]

◆ setTransparency() [2/2]

◆ setVPDFLT()

◆ subErase()

◆ subGetClassID()

◆ subSetAttributes()

◆ subViewportDraw()

◆ subWorldDraw()

◆ transparency() [1/2]

◆ transparency() [2/2]

◆ VPDFLT()