CFx SDK Documentation 2026 SP0
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
OdXRefLayerPropertyOverride Class Reference

#include <XRefLayerPropertyOverride.h>

Public Types

enum  XRefLayerPropertyOverrideType {
  On = 0 , Freeze , Lock , Plot ,
  Color , Linetype , Lineweight , Transparency ,
  PlotStyle , NewVPFreeze , Description
}
 

Static Public Member Functions

static bool hasXRefLayerOverride (OdDbObjectId hostLayerId, XRefLayerPropertyOverrideType p)
 
static bool hasAnyXRefLayerOverrides (OdDbObjectId hostLayerId)
 
static bool hasAnyXRefLayerOverrides (OdDbDatabase *pHostDb)
 
static bool hasXRefLayerOverride (OdDbBlockReference *pRef)
 
static void addXRefLayerOverride (OdDbObjectId hostLayerId, XRefLayerPropertyOverrideType p)
 
static void addXRefLayerOverride (OdDbObject *hostLayer, XRefLayerPropertyOverrideType p)
 
static void removeXRefLayerOverride (OdDbObjectId hostLayerId, XRefLayerPropertyOverrideType p)
 
static void removeXRefLayerOverride (OdDbDatabase *pHostDb, XRefLayerPropertyOverrideType p)
 
static void removeXRefLayerOverrides (OdDbObjectId hostLayerId)
 
static void removeXRefLayerOverrides (OdDbDatabase *pHostDb)
 
static void enableXRefLayerPropertyOverrideRecording ()
 
static void disableXRefLayerPropertyOverrideRecording ()
 
static bool isXRefLayerPropertyOverrideRecordingEnabled ()
 

Detailed Description

Helper class to get/set xref layer overrides <group OdDb_Classes>

Definition at line 32 of file XRefLayerPropertyOverride.h.

Member Enumeration Documentation

◆ XRefLayerPropertyOverrideType

enum OdXRefLayerPropertyOverride::XRefLayerPropertyOverrideType

This enum type indicates which xref layer property is overridden in the host drawing It can be used to get/set specific property override of xref layer (The order corresponds to VISRETAINMODE control bits)

Enumerator
On 
Freeze 
Lock 
Plot 
Color 
Linetype 
Lineweight 
Transparency 
PlotStyle 
NewVPFreeze 
Description 

Definition at line 41 of file XRefLayerPropertyOverride.h.

Member Function Documentation

◆ addXRefLayerOverride() [1/2]

static void OdXRefLayerPropertyOverride::addXRefLayerOverride ( OdDbObject * hostLayer,
XRefLayerPropertyOverrideType p )
static

This function is set which layer property is overridden in a xref layer (in host drawing) the flag is saved in xdata of xref layer with in the host drawing

Parameters
layer[in] The xref layer in the host drawing
p[in] the enum value indicating which property to set

◆ addXRefLayerOverride() [2/2]

static void OdXRefLayerPropertyOverride::addXRefLayerOverride ( OdDbObjectId hostLayerId,
XRefLayerPropertyOverrideType p )
static

This function is set which layer property is overridden in a xref layer (in host drawing) the flag is saved in xdata of xref layer with in the host drawing

Parameters
layerId[in] The xref layer id in the host drawing
p[in] the enum value indicating which property to set

◆ disableXRefLayerPropertyOverrideRecording()

static void OdXRefLayerPropertyOverride::disableXRefLayerPropertyOverrideRecording ( )
static

To disable xref layer override recording if override recording is disabled, then the modification on xref layer property will not be automatically marked as an override xdata flag will not be added for this layer property in layer table record's xdata

Remarks
By default the xref override recording is enabled (this is a global application flag)

◆ enableXRefLayerPropertyOverrideRecording()

static void OdXRefLayerPropertyOverride::enableXRefLayerPropertyOverrideRecording ( )
static

To enable xref layer override recording if override recording is enabled, then any modification on xref layer property will be automatically marked as an override,

Remarks
By default the xref override recording is enabled (this is a global application flag)

◆ hasAnyXRefLayerOverrides() [1/2]

static bool OdXRefLayerPropertyOverride::hasAnyXRefLayerOverrides ( OdDbDatabase * pHostDb)
static

Shortcut of hasXrefLayerOverride, return true if any xref layer property override found in the host drawing

Parameters
pHostDb[in] The pointer to host drawing's database
Returns
return true if any xref layer property override found in the host drawing

◆ hasAnyXRefLayerOverrides() [2/2]

static bool OdXRefLayerPropertyOverride::hasAnyXRefLayerOverrides ( OdDbObjectId hostLayerId)
static

Shortcut of hasXrefLayerOverride, return true if any xref layer property override found in the xref layer

Parameters
hostLayerId[in] The xref layer id in the host drawing
Returns
returns true if any xref layer property override found in the layer

◆ hasXRefLayerOverride() [1/2]

static bool OdXRefLayerPropertyOverride::hasXRefLayerOverride ( OdDbBlockReference * pRef)
static

Check whether the external reference has layer overrides

Parameters
pRef[in] The pointer to xref block reference
Returns
return true if the external reference has layer overrides

◆ hasXRefLayerOverride() [2/2]

static bool OdXRefLayerPropertyOverride::hasXRefLayerOverride ( OdDbObjectId hostLayerId,
XRefLayerPropertyOverrideType p )
static

This function is to check whether the xref layer property is overridden or not in host drawing. If xdata flag is not found in the xref layer, we will use xref cache to compare the layer property from xref and current layer property in host drawing, and take it as overridden if they are different. If xdata is already added, then the bit coded data in xdata will be parsed to check whether the specified property is overridden or not

Parameters
hostLayerId[in] The xref layer record id in host drawing
p[in] the enum value specifying which property to query
Returns
Returns true if the given property is overridden in xref layer (in host drawing)

◆ isXRefLayerPropertyOverrideRecordingEnabled()

static bool OdXRefLayerPropertyOverride::isXRefLayerPropertyOverrideRecordingEnabled ( )
static

To check whether xref layer override recording is enabled If override recording is enabled, then any modification on xref layer property will be automatically marked as an override (this is a global application flag)

Returns
return true if xref layer override recording is enabled, otherwise return false

◆ removeXRefLayerOverride() [1/2]

static void OdXRefLayerPropertyOverride::removeXRefLayerOverride ( OdDbDatabase * pHostDb,
XRefLayerPropertyOverrideType p )
static

shortcut of removeXRefLayerOverrides, remove specified layer property override in the whole drawing

Parameters
pHostDb[in] The pointer to host drawing's database
p[in] the enum value indicating which property to remove

◆ removeXRefLayerOverride() [2/2]

static void OdXRefLayerPropertyOverride::removeXRefLayerOverride ( OdDbObjectId hostLayerId,
XRefLayerPropertyOverrideType p )
static

This function is to turn off the flag in xref layer indicating which layer property will be overridden

Parameters
layerId[in] The xref layer record id in host drawing
p[in] the enum value indicating which property to remove

◆ removeXRefLayerOverrides() [1/2]

static void OdXRefLayerPropertyOverride::removeXRefLayerOverrides ( OdDbDatabase * pHostDb)
static

shortcut of removeXRefLayerOverride, remove all xref layer property overrides in the whole drawing

Parameters
pHostDb[in] The pointer to host drawing's database

◆ removeXRefLayerOverrides() [2/2]

static void OdXRefLayerPropertyOverride::removeXRefLayerOverrides ( OdDbObjectId hostLayerId)
static

Shortcut of removeXRefLayerOverride, remove all xref layer property overrides

Parameters
layerIdThe xref layer id in the host drawing
The documentation for this class was generated from the following file:
Generated on Tue Apr 15 2025 11:30:36