CFx SDK Documentation  2023 SP0
Public Types | Public Member Functions | List of all members
AECWallModifier Class Reference

#include <AECWallModifier.h>

Inheritance diagram for AECWallModifier:
AECImpObj OdRxObjectImpl< OdRxObject, AECImpObj > OdRxObject

Public Types

enum  ApplyTo { eLeft = 0 , eRight = 1 , eBoth = 2 }
 

Public Member Functions

double GetLength () const
 
void SetLength (double dLength)
 
double GetDepth () const
 
void SetDepth (double dDepth)
 
OdDbObjectId GetModStyle () const
 
void SetModStyle (const OdDbObjectId &id)
 
OdUInt16 GetComponentIndex () const
 
void SetComponentIndex (OdUInt16 iIndex)
 
bool IsDrawnSizeUsed () const
 
void SetIsDrawnSizeUsed (bool bUsed)
 
bool IsMirrorX () const
 
void SetIsMirrorX (bool bMirrored)
 
bool IsMirrorY () const
 
void SetIsMirrorY (bool bMirrored)
 
ApplyTo GetApplyFlag () const
 
void SetApplyFlag (ApplyTo eTo)
 
AECAnchorToCurveXSubPtr GetAnchorToCurveX () const
 
AECWallElevSubPtr GetBottomElevation () const
 
AECWallElevSubPtr GetTopElevation () const
 
- 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
 

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 ()
 
- Protected Attributes inherited from AECImpObj
class AECSIBase * m_pImp
 DOM. More...
 
OdUInt16 m_iMinSupportedVersion
 

Detailed Description

Wall Modifier.

<group TA_API_Subobjects_Wall>

Definition at line 36 of file AECWallModifier.h.

Member Enumeration Documentation

◆ ApplyTo

Contains set of variants of how the modifier is be applied.

Remarks
Enumerator
eLeft 
eRight 
eBoth 

Definition at line 46 of file AECWallModifier.h.

Member Function Documentation

◆ GetAnchorToCurveX()

AECAnchorToCurveXSubPtr AECWallModifier::GetAnchorToCurveX ( ) const

Returns the object, which binds the modifier to the wall.

Remarks
This method is supposed to be used for both read and write access.

◆ GetApplyFlag()

ApplyTo AECWallModifier::GetApplyFlag ( ) const

Returns how the modifier affects the wall.

Remarks
The eLeft value (equal to 0) specifies that the modifier should be applied to the left side of the wall (if the user looks along the X axis direction from the wall start point). The eRight value (equal to 1) indicates that the modifier should be applied to the right side of the wall and the eBoth value indicates that the modifier is applied to both sides of the wall (mirrored).

◆ GetBottomElevation()

AECWallElevSubPtr AECWallModifier::GetBottomElevation ( ) const

Returns the bottom elevation.

◆ GetComponentIndex()

OdUInt16 AECWallModifier::GetComponentIndex ( ) const

Returns the index of the component the modifier is applied to.

◆ GetDepth()

double AECWallModifier::GetDepth ( ) const

Returns the depth of the modifier.

Remarks
For "out" bulges the value is positive, for "in" bulges the value is negative. If modifier describes the in-bulge and the summarized (if the modifier is applied to both wall sides) depth of the modifier is greater than the wall thickness, then the modifier causes the wall to be split into two (upper/lower) parts. This situation should be handled separately by the drawing procedures.

◆ GetLength()

double AECWallModifier::GetLength ( ) const

Return the length of wall modifier.

Remarks
Measured along the length of wall.

◆ GetModStyle()

OdDbObjectId AECWallModifier::GetModStyle ( ) const

Returns the Object ID of wall modifier style.

Remarks
AECDbWallModStyle object stores the contour of wall modifier.

◆ GetTopElevation()

AECWallElevSubPtr AECWallModifier::GetTopElevation ( ) const

Returns the top elevation.

◆ IsDrawnSizeUsed()

bool AECWallModifier::IsDrawnSizeUsed ( ) const

Returns "Use Drawn Size" flag.

◆ IsMirrorX()

bool AECWallModifier::IsMirrorX ( ) const

Returns whether the modifier is mirrored about X axis.

◆ IsMirrorY()

bool AECWallModifier::IsMirrorY ( ) const

Returns whether the modifier is mirrored about Y axis.

◆ SetApplyFlag()

void AECWallModifier::SetApplyFlag ( ApplyTo  eTo)

Sets how the modifier affects the wall.

◆ SetComponentIndex()

void AECWallModifier::SetComponentIndex ( OdUInt16  iIndex)

Sets the index of the component the modifier is applied to.

◆ SetDepth()

void AECWallModifier::SetDepth ( double  dDepth)

Sets the depth of the modifier.

◆ SetIsDrawnSizeUsed()

void AECWallModifier::SetIsDrawnSizeUsed ( bool  bUsed)

Sets "Use Drawn Size" flag.

◆ SetIsMirrorX()

void AECWallModifier::SetIsMirrorX ( bool  bMirrored)

Sets whether the modifier is mirrored about X axis.

◆ SetIsMirrorY()

void AECWallModifier::SetIsMirrorY ( bool  bMirrored)

Sets whether the modifier is mirrored about Y axis.

◆ SetLength()

void AECWallModifier::SetLength ( double  dLength)

Sets the length of the modifier.

Remarks
Measured along the length of wall.

◆ SetModStyle()

void AECWallModifier::SetModStyle ( const OdDbObjectId id)

Sets the Object ID of wall modifier style.

Remarks
AECDbWallModStyle object stores the contour of wall modifier.

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