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

#include <AECWallCutLine.h>

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

Public Types

enum  Side { eTop = 0 , eBottom = 1 }
 
enum  CutlineAnchorFlags {
  eVertDefault = 0 , eVertBaseLine = 0x1 , eVertPrevPoint = 0x2 , eVertNextPoint = 0x3 ,
  eVertBaseHeight = 0x4 , eHorzDefault = 0 , eHorzWallStart = 0x10 , eHorzWallEnd = 0x20 ,
  eHorzWallMidPoint = 0x30 , eHorzPrevPoint = 0x40 , eHorzNextPoint = 0x50 , eHorzMidOfNeighbours = 0x60
}
 

Public Member Functions

Side GetSide () const
 
void SetSide (Side eSide)
 
OdUInt32 GetAnchorCount () const
 
AECWallCutLineAnchorSubPtr GetAnchor (OdUInt32 iIndex) const
 
AECImpArraySubPtr GetAnchors () const
 
double GetHorizontalOffset (OdUInt32 iIndex, double dWallLength=0) const
 
double GetVerticalOffset (OdUInt32 iIndex, double dBaseHeight=0) const
 
void Reverse ()
 
void GetRawCutLine (FacetModeler::Contour2D &cCutLine, double dWallLength=0, double dWallHeight=0) const
 
void SetRawCutLine (const FacetModeler::Contour2D &cCutLine, double dWallLength=0, double dWallHeight=0)
 
- 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

Side m_eSide
 
AECImpArray m_aWallCutLineAnchors
 
- Protected Attributes inherited from AECImpObj
class AECSIBase * m_pImp
 DOM. More...
 
OdUInt16 m_iMinSupportedVersion
 

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

Wall Cut Line.

<group TA_API_Subobjects_Wall>

Definition at line 36 of file AECWallCutLine.h.

Member Enumeration Documentation

◆ CutlineAnchorFlags

Flags for Set/Get RawCutline methods. Combination of eHorz* and eVert* flags is returned as metadata by GetRawCutline method and is handled by SetRawCutline method. Use cCutLine.metadataAt, cCutLine.setMetatadaAt, cCutLine.setAllMetadata to access the flags.

Enumerator
eVertDefault 
eVertBaseLine 
eVertPrevPoint 
eVertNextPoint 
eVertBaseHeight 
eHorzDefault 
eHorzWallStart 
eHorzWallEnd 
eHorzWallMidPoint 
eHorzPrevPoint 
eHorzNextPoint 
eHorzMidOfNeighbours 

Definition at line 122 of file AECWallCutLine.h.

◆ Side

The side of the cutline.

Enumerator
eTop 
eBottom 

Definition at line 44 of file AECWallCutLine.h.

Member Function Documentation

◆ GetAnchor()

AECWallCutLineAnchorSubPtr AECWallCutLine::GetAnchor ( OdUInt32  iIndex) const

Returns anchor by index.

Throws:

Cause eInvalidIndex Specified index is out of bounds

◆ GetAnchorCount()

OdUInt32 AECWallCutLine::GetAnchorCount ( ) const

Returns the number of anchors in cutline.

◆ GetAnchors()

AECImpArraySubPtr AECWallCutLine::GetAnchors ( ) const

Returns the array of anchors.

◆ GetHorizontalOffset()

double AECWallCutLine::GetHorizontalOffset ( OdUInt32  iIndex,
double  dWallLength = 0 
) const

Calculates the offset from Wall start to the position of anchor with specified index along X axis in Wall OCS.

Throws:

Cause eInvalidIndex Specified index is out of bounds

◆ GetRawCutLine()

void AECWallCutLine::GetRawCutLine ( FacetModeler::Contour2D cCutLine,
double  dWallLength = 0,
double  dWallHeight = 0 
) const

Returns cutline contour.

Remarks
Contour is returned in Wall OCS. X coordinate is measured along X Axis in Wall OCS. Y coordinate is measured along Z Axis in Wall OCS. Wall length and height are obtained from the owner AECDbWall by default.

Note that self-intersecting cutline is considered invalid. You may check this condition by calling of FacetModeler::Contour2D::isSelfIntersecting.

◆ GetSide()

Side AECWallCutLine::GetSide ( ) const

Returns the side of cutline.

◆ GetVerticalOffset()

double AECWallCutLine::GetVerticalOffset ( OdUInt32  iIndex,
double  dBaseHeight = 0 
) const

Calculates the offset from Wall bottom to the position of anchor with specified index along Z axis in Wall OCS.

Throws:

Cause eInvalidIndex Specified index is out of bounds

◆ Reverse()

void AECWallCutLine::Reverse ( )

Reverses the cutline. All anchors are reversed, "after" and "before", "WallStart" and "WallEnd" and other horizontal relations are swapped.

◆ SetRawCutLine()

void AECWallCutLine::SetRawCutLine ( const FacetModeler::Contour2D cCutLine,
double  dWallLength = 0,
double  dWallHeight = 0 
)

Sets cutline contour. This method uses cCutline.metadataAt() flags to set anchor horizontal and vertical relations. Appropriate defaults are used for vertices with zero flags. Wall length and height are obtained from the owner AECDbWall by default.

◆ SetSide()

void AECWallCutLine::SetSide ( Side  eSide)

Sets the side of cutline.

Member Data Documentation

◆ m_aWallCutLineAnchors

AECImpArray AECWallCutLine::m_aWallCutLineAnchors
protected

Definition at line 168 of file AECWallCutLine.h.

◆ m_eSide

Side AECWallCutLine::m_eSide
protected

Definition at line 165 of file AECWallCutLine.h.


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