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

#include <AECAnchorToCurveX.h>

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

Public Types

enum  From { eStartOfCurve = 0 , eEndOfCurve = 1 , eMidpointOfCurve = 2 }
 
enum  To { eCenter = 0 , eStartEdge = 1 , eEndEdge = 2 }
 

Public Member Functions

double GetOffset () const
 
void SetOffset (double dOffset)
 
From GetFrom () const
 
void SetFrom (From eFrom)
 
To GetTo () const
 
void SetTo (To eTo)
 
double GetInsertionOffset (double dLength, bool adjustToBounds=true) const
 
double GetOriginInsertionOffset (double dLength, double dObjectLength, double dRadius) const
 
double GetDerivInsertionOffset (double dObjectLength) 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
 

Protected Attributes

double m_dOffset
 
From m_uFrom
 
To m_uTo
 
- 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

Relative position of entity anchored to curve X axis.

<group TA_API_Subobjects_General>

Definition at line 34 of file AECAnchorToCurveX.h.

Member Enumeration Documentation

◆ From

Defines the point on base curve from which the offset is measured.

Enumerator
eStartOfCurve 
eEndOfCurve 
eMidpointOfCurve 

Definition at line 43 of file AECAnchorToCurveX.h.

◆ To

Defines the point on entity anchored to curve.

Enumerator
eCenter 
eStartEdge 
eEndEdge 

Definition at line 53 of file AECAnchorToCurveX.h.

Member Function Documentation

◆ GetDerivInsertionOffset()

double AECAnchorToCurveX::GetDerivInsertionOffset ( double  dObjectLength) const

Returns the offset along the object x dimension to the center of the object from the point of anchoring.

Parameters
dObjectLength[in] - The dimension of the entity along x axis.

◆ GetFrom()

From AECAnchorToCurveX::GetFrom ( ) const

Returns type of point on curve.

◆ GetInsertionOffset()

double AECAnchorToCurveX::GetInsertionOffset ( double  dLength,
bool  adjustToBounds = true 
) const

Returns the insertion offset along the curve.

Parameters
dLength[in] - curve dimension along X axis.
adjustToBounds[in] - if the result is out of bounds [0, dLength] it will be adjusted to correspondent end.

◆ GetOffset()

double AECAnchorToCurveX::GetOffset ( ) const

Returns the offset.

◆ GetOriginInsertionOffset()

double AECAnchorToCurveX::GetOriginInsertionOffset ( double  dLength,
double  dObjectLength,
double  dRadius 
) const

Returns the insertion offset along the curve for entity`s origin.

Parameters
dLength[in] - curve dimension along X axis.
dObjectLength[in] - entity dimension along X axis.
dRadius[in] - The radius of the curve if it is arced. Need for some types of anchoring. It is 0 if there is no need to use it or the curve is linear.

◆ GetTo()

To AECAnchorToCurveX::GetTo ( ) const

Returns type of point on entity.

◆ SetFrom()

void AECAnchorToCurveX::SetFrom ( From  eFrom)

Sets type of point on curve.

◆ SetOffset()

void AECAnchorToCurveX::SetOffset ( double  dOffset)

Sets the offset.

◆ SetTo()

void AECAnchorToCurveX::SetTo ( To  eTo)

Sets type of point on entity.

Member Data Documentation

◆ m_dOffset

double AECAnchorToCurveX::m_dOffset
protected

Definition at line 127 of file AECAnchorToCurveX.h.

◆ m_uFrom

From AECAnchorToCurveX::m_uFrom
protected

Definition at line 131 of file AECAnchorToCurveX.h.

◆ m_uTo

To AECAnchorToCurveX::m_uTo
protected

Definition at line 136 of file AECAnchorToCurveX.h.


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