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

#include <AECStairCreatorSpiral.h>

Inheritance diagram for AECStairCreatorSpiral:
AECStairCreator AECImpObj OdRxObjectImpl< OdRxObject, AECImpObj > OdRxObject

Public Member Functions

const OdGePoint2dGetRefPoint () const
 
void SetRefPoint (const OdGePoint2d &pt)
 
AECDefs::StairSpiralConstraint GetConstraint () const
 
void SetConstraint (AECDefs::StairSpiralConstraint eConstraint)
 
bool IsClockwise () const
 
void SetIsClockwise (bool bClockwise)
 
double GetAngle () const
 
void SetAngle (double dAngle)
 
double GetAnglePerTread () const
 
void SetAnglePerTread (double dAngle)
 
void AdjustLength (double dLength, double dTread)
 
- Public Member Functions inherited from AECStairCreator
double GetBaseWidth () const
 
void SetBaseWidth (double dWidth)
 
- 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

Spiral Stair Creator.

<group TA_API_Subobjects_Stair>

Definition at line 35 of file AECStairCreatorSpiral.h.

Member Function Documentation

◆ AdjustLength()

void AECStairCreatorSpiral::AdjustLength ( double  dLength,
double  dTread 
)

Adjusts using specified length.

Remarks
Used internally.

◆ GetAngle()

double AECStairCreatorSpiral::GetAngle ( ) const

Returns the including angle.

Remarks
Angle is constant for esscTotalDegrees constraint.

◆ GetAnglePerTread()

double AECStairCreatorSpiral::GetAnglePerTread ( ) const

Returns the including angle for single tread.

Remarks
Angle Per Tread is constant for esscDegreesPerTread constraint.

◆ GetConstraint()

AECDefs::StairSpiralConstraint AECStairCreatorSpiral::GetConstraint ( ) const

Returns the typs of spiral constraint.

◆ GetRefPoint()

const OdGePoint2d& AECStairCreatorSpiral::GetRefPoint ( ) const

Returns start point of the spiral.

Remarks
Radius is equal to ref point "length".

Radius is constant for esscFree constraint.

◆ IsClockwise()

bool AECStairCreatorSpiral::IsClockwise ( ) const

Returns whether spiral direction is clockwise.

◆ SetAngle()

void AECStairCreatorSpiral::SetAngle ( double  dAngle)

Sets the including angle.

Remarks
Angle is constant for esscTotalDegrees constraint.

◆ SetAnglePerTread()

void AECStairCreatorSpiral::SetAnglePerTread ( double  dAngle)

Sets the including angle for single tread.

Remarks
Angle Per Tread is constant for esscDegreesPerTread constraint.

◆ SetConstraint()

void AECStairCreatorSpiral::SetConstraint ( AECDefs::StairSpiralConstraint  eConstraint)

Sets the typs of spiral constraint.

◆ SetIsClockwise()

void AECStairCreatorSpiral::SetIsClockwise ( bool  bClockwise)

Sets whether spiral direction is clockwise.

◆ SetRefPoint()

void AECStairCreatorSpiral::SetRefPoint ( const OdGePoint2d pt)

Sets start point of the spiral.

Remarks
Radius is equal to ref point "length".

Radius is constant for esscFree constraint.


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