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

#include <AECCustomOpeningBlock.h>

Inheritance diagram for AECCustomOpeningBlock:
AECDispCompEnt AECDispComp AECImpObj OdRxObjectImpl< OdRxObject, AECImpObj > OdRxObject AECCustomDoorBlock AECCustomOpenFillerBlock AECCustomWindowBlock

Public Types

enum  Display { eAlways = 0 , eWhenIntersectingCutPlane = 1 , eWhenAboveCutPlane = 2 , eWhenBelowCutPlane = 3 }
 
- Public Types inherited from AECDispCompEnt
enum  XPosition { exLeft = 0 , exCenter = 1 , exRight = 2 }
 
enum  YPosition { eyFront = 0 , eyCenter = 1 , eyBack = 2 }
 
enum  ZPosition { ezBottom = 0 , ezCenter = 1 , ezTop = 2 }
 

Public Member Functions

OdDbObjectId GetBlock () const
 
void SetBlock (const OdDbObjectId &idBlock)
 
XPosition GetXPosition () const
 
void SetXPosition (XPosition ePosition)
 
YPosition GetYPosition () const
 
void SetYPosition (YPosition ePosition)
 
ZPosition GetZPosition () const
 
void SetZPosition (ZPosition ePosition)
 
bool IsMirrorX () const
 
void SetIsMirrorX (bool bMirror)
 
bool IsMirrorY () const
 
void SetIsMirrorY (bool bMirror)
 
bool IsMirrorZ () const
 
void SetIsMirrorZ (bool bMirror)
 
bool IsScaleToFitWidth () const
 
void SetIsScaleToFitWidth (bool bScale)
 
bool IsScaleToFitHeight () const
 
void SetIsScaleToFitHeight (bool bScale)
 
bool IsScaleToFitDepth () const
 
void SetIsScaleToFitDepth (bool bScale)
 
bool IsScaleToFitLockXYRatio () const
 
void SetIsScaleToFitLockXYRatio (bool bScale)
 
const OdGeVector3dGetInsertionOffset () const
 
void SetInsertionOffset (const OdGeVector3d &vOffset)
 
Display GetDisplayOption () const
 
void SetDisplayOption (Display displayOption)
 
void GetOffsetFromOrigin (const OdGeVector3d &vEntityDimension, OdGeVector3d &vOffset) const
 
- Public Member Functions inherited from AECDispCompEnt
virtual void SetDbProperties (const OdDbDatabase *pDb)
 DOM. More...
 
bool IsVisible () const
 
void SetIsVisible (bool bVisible)
 
const OdCmColorGetColor () const
 
void SetColor (const OdCmColor &cColor)
 
OdDbObjectId GetLayer () const
 
void SetLayer (const OdDbObjectId &idLayer)
 
OdDbObjectId GetLinetype () const
 
void SetLinetype (const OdDbObjectId &idLinetype)
 
OdDb::LineWeight GetLineWeight () const
 
void SetLineWeight (OdDb::LineWeight eLineWeight)
 
double GetLtScale () const
 
void SetLtScale (double dScale)
 
OdDb::PlotStyleNameType GetPlotStyleNameType () const
 
void SetPlotStyleNameType (OdDb::PlotStyleNameType eType)
 
OdDbObjectId GetPlotStyle () const
 
void SetPlotStyle (const OdDbObjectId &idPlotStyle)
 
bool MayBeByMaterial () const
 
void SetMayBeByMaterial (bool bMayBeByMaterial)
 
bool IsByMaterial () const
 
void SetIsByMaterial (bool bByMaterial)
 
- Public Member Functions inherited from AECImpObj
const OdStringGetDescription () const
 
void SetDescription (const OdString &strDescription)
 
virtual void onObjectLoaded ()
 
virtual void SubClose ()
 DOM. More...
 
OdRxObjectGetOwner () const
 
OdRxObjectGetOwner (OdRxClass *pClass) const
 
void addRefSubPtr ()
 
void releaseSubPtr ()
 
void assertReadEnabled () const
 
void assertWriteEnabled (bool autoUndo=true, bool recordModified=true)
 
bool isReadEnabled () const
 
bool isWriteEnabled () const
 
OdDbDatabasedatabase () const
 
void copyFrom (const OdRxObject *pOther)
 
virtual OdUInt16 minSupportedVersion () const
 
void SetOwner (OdDbObject *pOwner)
 DOM. More...
 
void SetOwner (AECImpObj *pOwner)
 DOM. More...
 
class AECSIBase * GetImpl () const
 DOM. More...
 
virtual OdResult dwgInFieldsEx20 (AECDbDwgFiler *pFiler)
 DOM. More...
 
virtual OdResult dwgInFieldsEx1 (AECDbDwgFiler *pFiler)
 DOM. More...
 
- Public Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
 OdRxObjectImpl ()
 
void addRef ()
 
void release ()
 
long numRefs () const
 
- Public Member Functions inherited from OdRxObject
 ODRX_HEAP_OPERATORS ()
 
 OdRxObject ()
 
virtual ~OdRxObject ()
 
virtual OdRxObjectqueryX (const OdRxClass *pClass) const
 
virtual OdRxObjectx (const OdRxClass *pClass) const
 
virtual OdRxClassisA () 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
 

Protected Attributes

OdDbHardPointerId m_blockId
 
BlockFlags m_uFlags
 
OdGeVector3d m_vInsertionOffset
 
OdUInt8 m_displayOption
 
- Protected Attributes inherited from AECDispCompEnt
bool m_bVisible
 
OdDbHardPointerId m_hpidDbLayerTableRecord
 
OdCmColor m_cColor
 
bool m_bNoneColor
 
OdDbHardPointerId m_hpidDbLineTypeTableRecord
 
OdDb::LineWeight m_eLineWeight
 
double m_dLtScale
 
OdDb::PlotStyleNameType m_ePlotStyleName
 
OdDbHardPointerId m_hpidPlotStyle
 
MaterialFlags m_iMaterialFlags
 
OdUInt32 m_unknSmartStrID
 DOM. More...
 
OdString m_unknSmartStrValue
 DOM. More...
 
OdInt32 m_iUnknown1
 DOM. More...
 
- Protected Attributes inherited from AECDispComp
bool m_bApplicable
 
bool m_bInherited
 
- Protected Attributes inherited from AECImpObj
class AECSIBase * m_pImp
 DOM. More...
 
OdUInt16 m_iMinSupportedVersion
 

Friends

class AECGaCustomBlock
 

Additional Inherited Members

- Static Public Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
static OdSmartPtr< AECImpObjcreateObject ()
 
- Static Public Member Functions inherited from OdRxObject
static OdRxObjectPtr cast (const OdRxObject *pointer)
 
static OdRxClassdesc ()
 
- Protected Member Functions inherited from OdRxObjectImpl< OdRxObject, AECImpObj >
 ODRX_HEAP_OPERATORS ()
 

Detailed Description

Opening custom block.

<group TA_API_Subobjects_Display_Components>

Definition at line 35 of file AECCustomOpeningBlock.h.

Member Enumeration Documentation

◆ Display

Display condition.

Enumerator
eAlways 
eWhenIntersectingCutPlane 
eWhenAboveCutPlane 
eWhenBelowCutPlane 

Definition at line 163 of file AECCustomOpeningBlock.h.

Member Function Documentation

◆ GetBlock()

OdDbObjectId AECCustomOpeningBlock::GetBlock ( ) const

Returns the Object ID of ACAD block.

◆ GetDisplayOption()

Display AECCustomOpeningBlock::GetDisplayOption ( ) const

◆ GetInsertionOffset()

const OdGeVector3d& AECCustomOpeningBlock::GetInsertionOffset ( ) const

Returns the offset of insertion point.

◆ GetOffsetFromOrigin()

void AECCustomOpeningBlock::GetOffsetFromOrigin ( const OdGeVector3d vEntityDimension,
OdGeVector3d vOffset 
) const

Returns the offset from the entity`s origin.

Parameters
vEntityDimension[in] - three dimensions of the entity.
vOffset[out] - offset from origin.

◆ GetXPosition()

XPosition AECCustomOpeningBlock::GetXPosition ( ) const

Returns the position of insertion point along X axis.

◆ GetYPosition()

YPosition AECCustomOpeningBlock::GetYPosition ( ) const

Returns the position of insertion point along Y axis.

◆ GetZPosition()

ZPosition AECCustomOpeningBlock::GetZPosition ( ) const

Returns the position of insertion point along Z axis.

◆ IsMirrorX()

bool AECCustomOpeningBlock::IsMirrorX ( ) const

Returns whether the block is mirrored about X axis.

◆ IsMirrorY()

bool AECCustomOpeningBlock::IsMirrorY ( ) const

Returns whether the block is mirrored about Y Axis.

◆ IsMirrorZ()

bool AECCustomOpeningBlock::IsMirrorZ ( ) const

Returns whether the block is mirrored about Z Axis.

◆ IsScaleToFitDepth()

bool AECCustomOpeningBlock::IsScaleToFitDepth ( ) const

Returns whether the block is scaled to fit depth.

◆ IsScaleToFitHeight()

bool AECCustomOpeningBlock::IsScaleToFitHeight ( ) const

Returns whether the block is scaled to fit height.

◆ IsScaleToFitLockXYRatio()

bool AECCustomOpeningBlock::IsScaleToFitLockXYRatio ( ) const

Returns whether the block is scaled to keep XY ratio.

◆ IsScaleToFitWidth()

bool AECCustomOpeningBlock::IsScaleToFitWidth ( ) const

Returns whether the block is scaled to fit width.

◆ SetBlock()

void AECCustomOpeningBlock::SetBlock ( const OdDbObjectId idBlock)

Sets the Object ID of ACAD block.

◆ SetDisplayOption()

void AECCustomOpeningBlock::SetDisplayOption ( Display  displayOption)

◆ SetInsertionOffset()

void AECCustomOpeningBlock::SetInsertionOffset ( const OdGeVector3d vOffset)

Sets the offset of insertion point.

◆ SetIsMirrorX()

void AECCustomOpeningBlock::SetIsMirrorX ( bool  bMirror)

Sets whether the block is mirrored about X axis.

◆ SetIsMirrorY()

void AECCustomOpeningBlock::SetIsMirrorY ( bool  bMirror)

Sets whether the block is mirrored about Y axis.

◆ SetIsMirrorZ()

void AECCustomOpeningBlock::SetIsMirrorZ ( bool  bMirror)

Sets whether the block is mirrored about Z axis.

◆ SetIsScaleToFitDepth()

void AECCustomOpeningBlock::SetIsScaleToFitDepth ( bool  bScale)

Sets whether the block is scaled to fit depth.

◆ SetIsScaleToFitHeight()

void AECCustomOpeningBlock::SetIsScaleToFitHeight ( bool  bScale)

Sets whether the block is scaled to fit height.

◆ SetIsScaleToFitLockXYRatio()

void AECCustomOpeningBlock::SetIsScaleToFitLockXYRatio ( bool  bScale)

Sets whether the block is scaled to keep XY ratio.

◆ SetIsScaleToFitWidth()

void AECCustomOpeningBlock::SetIsScaleToFitWidth ( bool  bScale)

Sets whether the block is scaled to fit width.

◆ SetXPosition()

void AECCustomOpeningBlock::SetXPosition ( XPosition  ePosition)

Sets the position of insertion point along X axis.

◆ SetYPosition()

void AECCustomOpeningBlock::SetYPosition ( YPosition  ePosition)

Sets the position of insertion point along Y axis.

◆ SetZPosition()

void AECCustomOpeningBlock::SetZPosition ( ZPosition  ePosition)

Sets the position of insertion point along Z axis.

Friends And Related Function Documentation

◆ AECGaCustomBlock

friend class AECGaCustomBlock
friend

Definition at line 198 of file AECCustomOpeningBlock.h.

Member Data Documentation

◆ m_blockId

OdDbHardPointerId AECCustomOpeningBlock::m_blockId
protected

Definition at line 186 of file AECCustomOpeningBlock.h.

◆ m_displayOption

OdUInt8 AECCustomOpeningBlock::m_displayOption
protected

Definition at line 195 of file AECCustomOpeningBlock.h.

◆ m_uFlags

BlockFlags AECCustomOpeningBlock::m_uFlags
protected

Definition at line 189 of file AECCustomOpeningBlock.h.

◆ m_vInsertionOffset

OdGeVector3d AECCustomOpeningBlock::m_vInsertionOffset
protected

Definition at line 192 of file AECCustomOpeningBlock.h.


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