AssociativePoint.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE

/*=================================================================================**/
struct AssociativePoint
{
enum CreateOptions
    {
    CREATE_ASSOC_Normal              = 0,        
    CREATE_ASSOC_DisallowFarElm      = (1 << 0), 
    CREATE_ASSOC_DisallowCustom      = (1 << 1), 
    CREATE_ASSOC_AllowAdjustedPoints = (1 << 2), 
    };

enum CreateMask
    {
    CREATE_ASSOC_MASK_DIMENSION = (1 << 0),
    CREATE_ASSOC_MASK_MLINE     = (1 << 1),
    CREATE_ASSOC_MASK_CELLS     = (1 << 2),
    CREATE_ASSOC_MASK_LINEAR    = (1 << 3),
    CREATE_ASSOC_MASK_NOTE      = (1 << 4),
    CREATE_ASSOC_MASK_TEXT      = (1 << 5),
    };

enum ArcLocation
    {
    ARC_ANGLE   = 0,
    ARC_CENTER  = 1,
    ARC_START   = 2,
    ARC_END     = 3,
    };


DGNPLATFORM_EXPORT static BentleyStatus IsValid
(
AssocPoint&     assocPoint,
DgnModelRefP    pathRoot,
DgnModelRefP    parentModel
);

DGNPLATFORM_EXPORT static BentleyStatus SetRoot
(
AssocPoint&     assocPoint,
ElementId       elemId,
ElementId       refAttId,
int             rootIndex = 0
);

DGNPLATFORM_EXPORT static BentleyStatus SetRoot
(
AssocPoint&     assocPoint,
DisplayPathCP   path,
DgnModelRefP    parentModel,
bool            allowFarElm,
int             rootIndex = 0
);

DGNPLATFORM_EXPORT static BentleyStatus GetRoot
(
DisplayPathP        path,           // <=> seed display path
int*                nRootsP,        // <=  intersect assoc will return 2, all others return 1
AssocPoint const&   assocPoint,     //  => assoc point to build a displaypath for
DgnModelRefP        modelRef,       //  => model ref of element this assoc is from
int                 rootIndex = 0   //  => which root to get (Use 0 for single elem assoc
);

DGNPLATFORM_EXPORT static void InitKeypoint
(
AssocPoint&     assocPoint,
UShort          vertex,    
UShort          nVertex,   
UShort          numerator, 
UShort          divisor
);

DGNPLATFORM_EXPORT static void InitOrigin
(
AssocPoint&     assocPoint,
UShort          option
);

DGNPLATFORM_EXPORT static void InitArc
(
AssocPoint&     assocPoint,
ArcLocation     keyPoint,
double          angle = 0.0
);

DGNPLATFORM_EXPORT static void InitProjection
(
AssocPoint&     assocPoint,
UShort          vertex,     
UShort          nVertex,    
double          ratio
);

DGNPLATFORM_EXPORT static void InitMline
(
AssocPoint&     assocPoint,
UShort          vertex,    
UShort          nVertex,   
UShort          lineNo,    
double          offset,    
bool            joint
);

DGNPLATFORM_EXPORT static void InitBCurve
(
AssocPoint&     assocPoint,
double          uParam
);

DGNPLATFORM_EXPORT static void InitBSurface
(
AssocPoint&     assocPoint,
double          uParam,     
double          vParam     
);

DGNPLATFORM_EXPORT static void InitMeshEdge
(
AssocPoint&     assocPoint,
int             edgeIndex, 
int             nEdge,     
double          uParam
);

DGNPLATFORM_EXPORT static void InitMeshVertex
(
AssocPoint&     assocPoint,
int             vertexIndex,
int             nVertex    
);

DGNPLATFORM_EXPORT static void InitIntersection
(
AssocPoint&     assocPoint,
byte            index,      
UShort          seg1,       
UShort          seg2,       
int             nSeg1,      
int             nSeg2
);

DGNPLATFORM_EXPORT static StatusInt ExtractPoint
(
AssocPoint&     assocPoint,
ElementHandleCR    element,
int             pointNum,
int             maxPoints
);

DGNPLATFORM_EXPORT static StatusInt InsertPoint
(
EditElementHandleR     element,
AssocPoint const&   assocPoint,
int                 pointNum,
int                 maxPoints
);

DGNPLATFORM_EXPORT static BentleyStatus GetPoint
(
DPoint3dP           outPoint,
AssocPoint const&   assocPoint,
DgnModelRefP        modelRef
);

DGNPLATFORM_EXPORT static StatusInt RemovePoint
(
EditElementHandleR element,
int             pointNum,
int             maxPoints
);

DGNPLATFORM_EXPORT static StatusInt RemoveAllAssociations
(
EditElementHandleR element
);

DGNPLATFORM_EXPORT static StatusInt CreateFromSnap
(
AssocPoint&         assocPoint,
SnapPathCP          pathIn,
int                 modifierMask,
DgnModelRefP        parentModel,
CreateOptions       options
);

DGNPLATFORM_EXPORT static void RegisterExtensions ();

}; // AssociativePoint


END_BENTLEY_DGNPLATFORM_NAMESPACE