CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | Protected Attributes | List of all members
AECCustomRailingRepresentation Class Reference

#include <AECCustomRailingRepresentation.h>

Inheritance diagram for AECCustomRailingRepresentation:
AECDispCompEnt AECDispComp AECImpObj OdRxObjectImpl< OdRxObject, AECImpObj > OdRxObject AECCustomRailingBlock AECCustomRailingProfile

Classes

union  ComponentFlags
 DOM. More...
 
union  GeometryFlags
 DOM. More...
 

Public Types

enum  AttachTo { eAll = 0 , eFirst = 1 , eLast = 2 , eSelection = 3 }
 
enum  XPosition { eXCenter = 0 , eXLeft = 1 , eXRight = 2 }
 
enum  YPosition { eYCenter = 0 , eYFront = 1 , eYBack = 2 }
 
enum  ZPosition { eZBottom = 0 , eZMiddle = 1 , eZTop = 2 }
 
- 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

bool IsScaleToFitWidth () const
 
void SetIsScaleToFitWidth (bool bScale)
 
bool IsScaleToFitDepth () const
 
void SetIsScaleToFitDepth (bool bScale)
 
bool IsScaleToFitLockXYRatio () const
 
void SetIsScaleToFitLockXYRatio (bool bScale)
 
bool IsBetweenComps () const
 
void SetIsBetweenComps (bool bBetween)
 
XPosition GetXPosition () const
 
void SetXPosition (XPosition ePosition)
 
YPosition GetYPosition () const
 
void SetYPosition (YPosition ePosition)
 
bool IsMirrorX () const
 
void SetIsMirrorX (bool bMirror)
 
bool IsMirrorY () const
 
void SetIsMirrorY (bool bMirror)
 
bool IsReplace () const
 
void SetIsReplace (bool bReplace)
 
bool IsHandrailComponent () const
 
void SetIsHandrailComponent (bool bOn)
 
bool IsGuardrailComponent () const
 
void SetIsGuardrailComponent (bool bOn)
 
bool IsBottomrailComponent () const
 
void SetIsBottomrailComponent (bool bOn)
 
bool IsFixedPostComponent () const
 
void SetIsFixedPostComponent (bool bOn)
 
bool IsDynamicPostComponent () const
 
void SetIsDynamicPostComponent (bool bOn)
 
bool IsBalusterComponent () const
 
void SetIsBalusterComponent (bool bOn)
 
AttachTo GetAttachTo () const
 
void SetAttachTo (AttachTo eType)
 
OdUInt16 GetSelectionStart () const
 
void SetSelectionStart (OdUInt16 iIndex)
 
OdUInt16 GetSelectionEnd () const
 
void SetSelectionEnd (OdUInt16 iIndex)
 
double GetZRotation () const
 
void SetZRotation (double dRotation)
 
bool IsSkippedComponent (OdUInt32 iOverall, OdUInt32 iIndex) const
 
bool IsDrawnForComponent (OdUInt32 iOverall, OdUInt32 iIndex) const
 
- Public Member Functions inherited from AECDispCompEnt
virtual void SetDbProperties (const OdDbDatabase *pDb)
 DOM.
 
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.
 
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.
 
void SetOwner (AECImpObj *pOwner)
 DOM.
 
class AECSIBase * GetImpl () const
 DOM.
 
virtual OdResult dwgInFieldsEx20 (AECDbDwgFiler *pFiler)
 DOM.
 
virtual OdResult dwgInFieldsEx1 (AECDbDwgFiler *pFiler)
 DOM.
 
- 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
 
virtual void addRef ()=0
 
virtual void release ()=0
 
virtual long numRefs () const
 
bool isKindOf (const OdRxClass *pClass) const
 
virtual OdRxObjectPtr clone () const
 
virtual void copyFrom (const OdRxObject *pSource)
 
virtual OdRx::Ordering comparedTo (const OdRxObject *pOther) const
 
virtual bool isEqualTo (const OdRxObject *pOther) const
 

Protected Attributes

GeometryFlags m_uGeometryFlags
 
ComponentFlags m_uComponentFlags
 
AttachTo m_eAttachTo
 
OdUInt16 m_iSelectionStart
 
OdUInt16 m_iSelectionEnd
 
double m_dRotateZ
 
- 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.
 
OdString m_unknSmartStrValue
 DOM.
 
OdInt32 m_iUnknown1
 DOM.
 
- Protected Attributes inherited from AECDispComp
bool m_bApplicable
 
bool m_bInherited
 
- Protected Attributes inherited from AECImpObj
class AECSIBase * m_pImp
 DOM.
 
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

Abstract base for Railing custom blocks and profiles.

<group TA_API_Subobjects_Display_Components>

Definition at line 34 of file AECCustomRailingRepresentation.h.

Member Enumeration Documentation

◆ AttachTo

This enum represents "Attach to" property of custom Railing block.

Enumerator
eAll 
eFirst 
eLast 
eSelection 

Definition at line 42 of file AECCustomRailingRepresentation.h.

◆ XPosition

This enum represents X insertion point

Enumerator
eXCenter 
eXLeft 
eXRight 

Definition at line 53 of file AECCustomRailingRepresentation.h.

◆ YPosition

This enum represents Y insertion point

Enumerator
eYCenter 
eYFront 
eYBack 

Definition at line 63 of file AECCustomRailingRepresentation.h.

◆ ZPosition

This enum represents Z insertion point

Enumerator
eZBottom 
eZMiddle 
eZTop 

Definition at line 73 of file AECCustomRailingRepresentation.h.

Member Function Documentation

◆ GetAttachTo()

AttachTo AECCustomRailingRepresentation::GetAttachTo ( ) const

Returns "Attach To" enumeration value.

◆ GetSelectionEnd()

OdUInt16 AECCustomRailingRepresentation::GetSelectionEnd ( ) const

Returns the number of last component, for which custom block is to be used.

Remarks
Used only for eSelection type of "Attach To" property.

◆ GetSelectionStart()

OdUInt16 AECCustomRailingRepresentation::GetSelectionStart ( ) const

Returns the number of first component, for which custom block is to be used.

Remarks
Used only for eSelection type of "Attach To" property.

◆ GetXPosition()

XPosition AECCustomRailingRepresentation::GetXPosition ( ) const

Returns the position of insertion point along X axis.

◆ GetYPosition()

YPosition AECCustomRailingRepresentation::GetYPosition ( ) const

Returns the position of insertion point along Y axis.

◆ GetZRotation()

double AECCustomRailingRepresentation::GetZRotation ( ) const

Returns the rotation around Z axis.

Remarks
Used only if custom Railing component is attached to posts (fixed, fynamic or baluster).

◆ IsBalusterComponent()

bool AECCustomRailingRepresentation::IsBalusterComponent ( ) const

Returns whether custom block is used for balusters.

◆ IsBetweenComps()

bool AECCustomRailingRepresentation::IsBetweenComps ( ) const

Returns "Between Comps" flag.

◆ IsBottomrailComponent()

bool AECCustomRailingRepresentation::IsBottomrailComponent ( ) const

Returns whether custom block is used for bottom rail component.

◆ IsDrawnForComponent()

bool AECCustomRailingRepresentation::IsDrawnForComponent ( OdUInt32  iOverall,
OdUInt32  iIndex 
) const

◆ IsDynamicPostComponent()

bool AECCustomRailingRepresentation::IsDynamicPostComponent ( ) const

Returns whether custom block is used for dynamic posts.

◆ IsFixedPostComponent()

bool AECCustomRailingRepresentation::IsFixedPostComponent ( ) const

Returns whether custom block is used for fixed posts.

◆ IsGuardrailComponent()

bool AECCustomRailingRepresentation::IsGuardrailComponent ( ) const

Returns whether custom block is used for guardrail component.

◆ IsHandrailComponent()

bool AECCustomRailingRepresentation::IsHandrailComponent ( ) const

Returns whether custom block is used for handrail component.

◆ IsMirrorX()

bool AECCustomRailingRepresentation::IsMirrorX ( ) const

Returns whether the block is mirrored about X axis.

◆ IsMirrorY()

bool AECCustomRailingRepresentation::IsMirrorY ( ) const

Returns whether the block is mirrored about Y axis.

◆ IsReplace()

bool AECCustomRailingRepresentation::IsReplace ( ) const

Returns whether custom block replaces railing component.

◆ IsScaleToFitDepth()

bool AECCustomRailingRepresentation::IsScaleToFitDepth ( ) const

Returns whether the block is scaled to fit depth.

◆ IsScaleToFitLockXYRatio()

bool AECCustomRailingRepresentation::IsScaleToFitLockXYRatio ( ) const

Returns whether the block is scaled to keep XY ratio.

◆ IsScaleToFitWidth()

bool AECCustomRailingRepresentation::IsScaleToFitWidth ( ) const

Returns whether the block is scaled to fit width.

◆ IsSkippedComponent()

bool AECCustomRailingRepresentation::IsSkippedComponent ( OdUInt32  iOverall,
OdUInt32  iIndex 
) const

Returns whether specified component index is skiped.

Remarks
The index is 0 based.

◆ SetAttachTo()

void AECCustomRailingRepresentation::SetAttachTo ( AttachTo  eType)

Sets "Attach To" enumeration value.

◆ SetIsBalusterComponent()

void AECCustomRailingRepresentation::SetIsBalusterComponent ( bool  bOn)

Sets whether custom block is used for balusters.

◆ SetIsBetweenComps()

void AECCustomRailingRepresentation::SetIsBetweenComps ( bool  bBetween)

Returns "Between Comps" flag.

◆ SetIsBottomrailComponent()

void AECCustomRailingRepresentation::SetIsBottomrailComponent ( bool  bOn)

Sets whether custom block is used for bottom rail component.

◆ SetIsDynamicPostComponent()

void AECCustomRailingRepresentation::SetIsDynamicPostComponent ( bool  bOn)

Sets whether custom block is used for dynamic posts.

◆ SetIsFixedPostComponent()

void AECCustomRailingRepresentation::SetIsFixedPostComponent ( bool  bOn)

Sets whether custom block is used for fixed posts.

◆ SetIsGuardrailComponent()

void AECCustomRailingRepresentation::SetIsGuardrailComponent ( bool  bOn)

Sets whether custom block is used for guardrail component.

◆ SetIsHandrailComponent()

void AECCustomRailingRepresentation::SetIsHandrailComponent ( bool  bOn)

Sets whether custom block is used for handrail component.

◆ SetIsMirrorX()

void AECCustomRailingRepresentation::SetIsMirrorX ( bool  bMirror)

Sets whether the block is mirrored about X axis.

◆ SetIsMirrorY()

void AECCustomRailingRepresentation::SetIsMirrorY ( bool  bMirror)

Sets whether the block is mirrored about Y axis.

◆ SetIsReplace()

void AECCustomRailingRepresentation::SetIsReplace ( bool  bReplace)

Sets whether custom block replaces railing component.

◆ SetIsScaleToFitDepth()

void AECCustomRailingRepresentation::SetIsScaleToFitDepth ( bool  bScale)

Sets whether the block is scaled to fit depth.

◆ SetIsScaleToFitLockXYRatio()

void AECCustomRailingRepresentation::SetIsScaleToFitLockXYRatio ( bool  bScale)

Sets whether the block is scaled to keep XY ratio.

◆ SetIsScaleToFitWidth()

void AECCustomRailingRepresentation::SetIsScaleToFitWidth ( bool  bScale)

Sets whether the block is scaled to fit width.

◆ SetSelectionEnd()

void AECCustomRailingRepresentation::SetSelectionEnd ( OdUInt16  iIndex)

Sets the number of last component, for which custom block is to be used.

Remarks
Used only for eSelection type of "Attach To" property.

◆ SetSelectionStart()

void AECCustomRailingRepresentation::SetSelectionStart ( OdUInt16  iIndex)

Sets the number of first component, for which custom block is to be used.

Remarks
Used only for eSelection type of "Attach To" property.

◆ SetXPosition()

void AECCustomRailingRepresentation::SetXPosition ( XPosition  ePosition)

Sets the position of insertion point along X axis.

◆ SetYPosition()

void AECCustomRailingRepresentation::SetYPosition ( YPosition  ePosition)

Sets the position of insertion point along Y axis.

◆ SetZRotation()

void AECCustomRailingRepresentation::SetZRotation ( double  dRotation)

Sets the rotation around Z axis.

Remarks
Used only if custom Railing component is attached to posts (fixed, fynamic or baluster).

Member Data Documentation

◆ m_dRotateZ

double AECCustomRailingRepresentation::m_dRotateZ
protected

Definition at line 411 of file AECCustomRailingRepresentation.h.

◆ m_eAttachTo

AttachTo AECCustomRailingRepresentation::m_eAttachTo
protected

Definition at line 402 of file AECCustomRailingRepresentation.h.

◆ m_iSelectionEnd

OdUInt16 AECCustomRailingRepresentation::m_iSelectionEnd
protected

Definition at line 408 of file AECCustomRailingRepresentation.h.

◆ m_iSelectionStart

OdUInt16 AECCustomRailingRepresentation::m_iSelectionStart
protected

Definition at line 405 of file AECCustomRailingRepresentation.h.

◆ m_uComponentFlags

ComponentFlags AECCustomRailingRepresentation::m_uComponentFlags
protected

Definition at line 398 of file AECCustomRailingRepresentation.h.

◆ m_uGeometryFlags

GeometryFlags AECCustomRailingRepresentation::m_uGeometryFlags
protected

Definition at line 395 of file AECCustomRailingRepresentation.h.


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