Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
GeometryId Struct Reference

#include <Constraint3dCoreApi.h>

Inheritance diagram for GeometryId:
RefCountedBase RefCounted< IRefCounted > IRefCounted BRepVertexGeometryId CurveGeometryId EdgeGeometryId FaceGeometryId FixedElementId RegionPlaneId CurveArcAxisGeometryId CurvePointGeometryId EdgeArcAxisGeometryId FaceAxisGeometryId

Public Types

enum  Type {
  Curve = 1, Face = 2, Element = 3, Edge = 4,
  RegionPlane = 5, BRepVertex = 6, CurvePoint = 7, BCurve = 8,
  FaceAxis = 9, CurveArcAxis = 10, EdgeArcAxis = 11, InvalidElement = 0xff
}
 
enum  Status {
  DCM3_G_UNKNOWN, DCM3_G_FIXED, DCM3_G_OVER_DEFINED, DCM3_G_NOT_CONSISTENT,
  DCM3_G_NOT_CONSISTENT_DIMENSIONS, DCM3_G_NOT_CONSISTENT_OTHER, DCM3_G_NOT_CONSISTENT_UNKNOWN, DCM3_G_NOT_CHANGED,
  DCM3_G_WELL_DEFINED, DCM3_G_UNDER_DEFINED, DCM3_G_WITHIN_BOUNDS
}
 
enum  DimensionToComponent {
  DCM3_DIMENSION_TO_NOT_SPECIFIED = 0, DCM3_DIMENSION_TO_EXTERIOR = 1, DCM3_DIMENSION_TO_CENTRE_POINT = 2, DCM3_DIMENSION_TO_AXIS = 3,
  DCM3_DIMENSION_TO_PLANE = 4, DCM3_DIMENSION_TO_SPINE = 5, DCM3_DIMENSION_TO_APEX = 6
}
 
enum  FlagMasks { FlagMask_ParamX = 0x0001, FlagMask_ParamY = 0x0001 << 1, FlagMask_EntityIndex = 0x0001 << 2 }
 

Public Member Functions

 GeometryId ()
 
Type GetType () const
 
Status GetStatus () const
 
void SetStatus (Status status)
 
ElementRefP GetElementRef () const
 
ElementHandleCR GetElement () const
 
PersistentElementPathCR GetRootPep () const
 
void SetRootPep (PersistentElementPathCR pep)
 
void SetElementRef (ElementRefP elementRef)
 
void SetBodyCache (Constraint3dBodyCacheP cache)
 
BentleyStatus GetBody (ISolidKernelEntityPtr &body) const
 
CONSTRAINT3DCORE_EXPORT
BentleyStatus 
Extract (DataInternalizer &source)
 
CONSTRAINT3DCORE_EXPORT
BentleyStatus 
GetRootRange (DRange3dR range) const
 
CONSTRAINT3DCORE_EXPORT
BentleyStatus 
SaveOptional (DataExternalizer &sink)
 
virtual
CONSTRAINT3DCORE_EXPORT
BentleyStatus 
_Save (DataExternalizer &sink)
 
virtual
CONSTRAINT3DCORE_EXPORT bool 
_LessThan (GeometryIdCR id0, GeometryIdCR id1) const
 
virtual BentleyStatus _GetMarkerLocation (DPoint3dR point) const
 
virtual BentleyStatus _Flash (ViewContextR viewContext) const
 
virtual bool _ValidateRootChange () const
 
virtual SolverGeometryPtr _CreateSolverGeometry (ISolidKernelEntityCR body, TransformCR dgnToSolverTransform, TransformCR solverToDgnTransform)
 
virtual SolverGeometryPtr _CreateSolverGeometry (CurveVectorCR curveVector, TransformCR dgnToSolverTransform, TransformCR solverToDgnTransform)
 
virtual BentleyStatus _GetSolidSubEntity (ISubEntityPtr &subEntity, ISolidKernelEntityPtr &body) const
 
virtual FaceId const * _GetFaceId () const
 
virtual EdgeId const * _GetEdgeId () const
 
virtual VertexId const * _GetVertexId () const
 
virtual DimensionToComponent _DimensionToComponent () const
 
virtual bool _OmitSolverGeometry ()
 
double GetParameter () const
 
void SetParameter (double parameter)
 
void GetParameter (DPoint2dR parameter) const
 
void SetParameter (DPoint2dCR parameter)
 
UInt32 GetEntityIndex () const
 
void SetEntityIndex (UInt32 entityIndex)
 
bool LessThanWithoutParams (GeometryIdCR id0, GeometryIdCR id1) const
 
CONSTRAINT3DCORE_EXPORT bool operator< (GeometryIdCR otherId) const
 
- Public Member Functions inherited from RefCounted< IRefCounted >
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 
UInt32 AddRef () const
 
UInt32 Release () const
 
 RefCounted ()
 
 RefCounted (RefCounted const &rhs)
 
RefCountedoperator= (RefCounted const &rhs)
 
UInt32 GetRefCount () const
 

Static Public Member Functions

static CONSTRAINT3DCORE_EXPORT
GeometryIdPtr 
Create (Type type, Status status, DataInternalizer &source, DgnModelRefR modelRef, Constraint3dBodyCacheP bodyCache=NULL)
 

Protected Member Functions

 GeometryId (ElementHandle eh, PersistentElementPathCR pep, Type type, Status status)
 
- Protected Member Functions inherited from RefCounted< IRefCounted >
virtual ~RefCounted ()
 
- Protected Member Functions inherited from IRefCounted
virtual ~IRefCounted ()
 
void * operator new (size_t size)
 
void operator delete (void *rawMemory, size_t size)
 

Protected Attributes

Type m_type
 
Status m_status
 
ElementHandle m_eh
 
PersistentElementPath m_pep
 
DPoint2d m_parameter
 
UInt32 m_entityIndex
 
Constraint3dBodyCacheP m_bodyCache
 

Member Enumeration Documentation

enum DimensionToComponent
strong
Enumerator
DCM3_DIMENSION_TO_NOT_SPECIFIED 
DCM3_DIMENSION_TO_EXTERIOR 
DCM3_DIMENSION_TO_CENTRE_POINT 
DCM3_DIMENSION_TO_AXIS 
DCM3_DIMENSION_TO_PLANE 
DCM3_DIMENSION_TO_SPINE 
DCM3_DIMENSION_TO_APEX 
enum FlagMasks
Enumerator
FlagMask_ParamX 
FlagMask_ParamY 
FlagMask_EntityIndex 
enum Status
strong
Enumerator
DCM3_G_UNKNOWN 
DCM3_G_FIXED 
DCM3_G_OVER_DEFINED 
DCM3_G_NOT_CONSISTENT 
DCM3_G_NOT_CONSISTENT_DIMENSIONS 
DCM3_G_NOT_CONSISTENT_OTHER 
DCM3_G_NOT_CONSISTENT_UNKNOWN 
DCM3_G_NOT_CHANGED 
DCM3_G_WELL_DEFINED 
DCM3_G_UNDER_DEFINED 
DCM3_G_WITHIN_BOUNDS 
enum Type
strong
Enumerator
Curve 
Face 
Element 
Edge 
RegionPlane 
BRepVertex 
CurvePoint 
BCurve 
FaceAxis 
CurveArcAxis 
EdgeArcAxis 
InvalidElement 

Constructor & Destructor Documentation

GeometryId ( ElementHandle  eh,
PersistentElementPathCR  pep,
Type  type,
Status  status 
)
protected

References m_parameter, and DPoint2d::Zero().

References m_parameter, and DPoint2d::Zero().

Member Function Documentation

virtual SolverGeometryPtr _CreateSolverGeometry ( ISolidKernelEntityCR  body,
TransformCR  dgnToSolverTransform,
TransformCR  solverToDgnTransform 
)
virtual

Reimplemented in BRepVertexGeometryId, EdgeGeometryId, and FaceGeometryId.

References NULL.

virtual SolverGeometryPtr _CreateSolverGeometry ( CurveVectorCR  curveVector,
TransformCR  dgnToSolverTransform,
TransformCR  solverToDgnTransform 
)
virtual

Reimplemented in RegionPlaneId, CurvePointGeometryId, and CurveGeometryId.

References NULL.

virtual DimensionToComponent _DimensionToComponent ( ) const
virtual
virtual BentleyStatus _Flash ( ViewContextR  viewContext) const
virtual
virtual EdgeId const* _GetEdgeId ( ) const
virtual

Reimplemented in EdgeGeometryId.

References NULL.

virtual FaceId const* _GetFaceId ( ) const
virtual

Reimplemented in FaceAxisGeometryId, and FaceGeometryId.

References NULL.

virtual BentleyStatus _GetMarkerLocation ( DPoint3dR  point) const
virtual
virtual BentleyStatus _GetSolidSubEntity ( ISubEntityPtr &  subEntity,
ISolidKernelEntityPtr &  body 
) const
virtual
virtual VertexId const* _GetVertexId ( ) const
virtual

Reimplemented in BRepVertexGeometryId.

References NULL.

virtual CONSTRAINT3DCORE_EXPORT bool _LessThan ( GeometryIdCR  id0,
GeometryIdCR  id1 
) const
virtual
virtual bool _OmitSolverGeometry ( )
virtual

Reimplemented in FixedElementId.

virtual CONSTRAINT3DCORE_EXPORT BentleyStatus _Save ( DataExternalizer &  sink)
virtual
virtual bool _ValidateRootChange ( ) const
virtual
static CONSTRAINT3DCORE_EXPORT GeometryIdPtr Create ( Type  type,
Status  status,
DataInternalizer &  source,
DgnModelRefR  modelRef,
Constraint3dBodyCacheP  bodyCache = NULL 
)
static
CONSTRAINT3DCORE_EXPORT BentleyStatus Extract ( DataInternalizer &  source)
BentleyStatus GetBody ( ISolidKernelEntityPtr &  body) const
ElementHandleCR GetElement ( ) const

References m_eh.

ElementRefP GetElementRef ( ) const

References m_eh.

UInt32 GetEntityIndex ( ) const

References m_entityIndex.

double GetParameter ( ) const

References m_parameter, and DPoint2d::x.

void GetParameter ( DPoint2dR  parameter) const

References m_parameter.

PersistentElementPathCR GetRootPep ( ) const

References m_pep.

CONSTRAINT3DCORE_EXPORT BentleyStatus GetRootRange ( DRange3dR  range) const
Status GetStatus ( ) const

References m_status.

Type GetType ( ) const

References m_type.

bool LessThanWithoutParams ( GeometryIdCR  id0,
GeometryIdCR  id1 
) const
CONSTRAINT3DCORE_EXPORT bool operator< ( GeometryIdCR  otherId) const

References _LessThan().

CONSTRAINT3DCORE_EXPORT BentleyStatus SaveOptional ( DataExternalizer &  sink)
void SetBodyCache ( Constraint3dBodyCacheP  cache)

References m_bodyCache.

void SetElementRef ( ElementRefP  elementRef)

References m_eh.

void SetEntityIndex ( UInt32  entityIndex)

References m_entityIndex.

void SetParameter ( double  parameter)
void SetParameter ( DPoint2dCR  parameter)

References m_parameter.

void SetRootPep ( PersistentElementPathCR  pep)

References m_pep.

void SetStatus ( Status  status)

References m_status.

Member Data Documentation

Constraint3dBodyCacheP m_bodyCache
protected

Referenced by SetBodyCache().

ElementHandle m_eh
protected
UInt32 m_entityIndex
protected

Referenced by GetEntityIndex(), and SetEntityIndex().

DPoint2d m_parameter
protected
PersistentElementPath m_pep
protected

Referenced by GetRootPep(), and SetRootPep().

Status m_status
protected

Referenced by GetStatus(), and SetStatus().

Type m_type
protected

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

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.