Public Member Functions | List of all members
ViewContext Struct Referenceabstract

#include <ViewContext.h>

Public Member Functions

StatusInt VisitElemHandle (ElementHandleCR, bool checkRange, bool checkScanCriteria)
 
StatusInt VisitTransient (ElementHandleCR, SymbologyOverridesP)
 
void PushPath (ElementRefP elemRef)
 
ElementRefP PopPath ()
 
ClipPlaneSetCP GetRangePlanes () const
 Get the clip planes that define the limits of the displayed volume. More...
 
Coordinate Query and Conversion
void LocalToFrustum (DPoint3dP frustumPts, DPoint3dCP localPts, int nPts) const
 Transfrom an array of points in the current local coordinate system into DgnCoordSystem::Frustum coordinates. More...
 
void LocalToView (DPoint4dP viewPts, DPoint3dCP localPts, int nPts) const
 Transfrom an array of points in the current local coordinate system into DgnCoordSystem::View coordinates. More...
 
void LocalToView (DPoint3dP viewPts, DPoint3dCP localPts, int nPts) const
 Transfrom an array of points in the current local coordinate system into DgnCoordSystem::View coordinates. More...
 
void FrustumToLocal (DPoint3dP localPts, DPoint3dCP frustumPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::Frustum into the current local coordinate system. More...
 
void ViewToLocal (DPoint3dP localPts, DPoint4dCP viewPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::View into the current local coordinate system. More...
 
void ViewToLocal (DPoint3dP localPts, DPoint3dCP viewPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::View into the current local coordinate system. More...
 
void NpcToView (DPoint3dP viewPts, DPoint3dCP npcPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::Npc into DgnCoordSystem::View. More...
 
void ViewToNpc (DPoint3dP npcPts, DPoint3dCP viewPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::View into DgnCoordSystem::Npc. More...
 
void NpcToFrustum (DPoint3dP frustumPts, DPoint3dCP npcPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::Npc into DgnCoordSystem::Frustum. More...
 
void FrustumToView (DPoint4dP viewPts, DPoint3dCP frustumPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::Frustum into DgnCoordSystem::View. More...
 
void FrustumToView (Point2d *viewPts, DPoint3dCP frustumPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::Frustum into DgnCoordSystem::View. More...
 
void ViewToFrustum (DPoint3dP frustumPts, DPoint4dCP viewPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::View into DgnCoordSystem::Frustum. More...
 
void ViewToFrustum (DPoint3dP frustumPts, DPoint3dCP viewPts, int nPts) const
 Transfrom an array of points in DgnCoordSystem::View into DgnCoordSystem::Frustum. More...
 
TransformCP GetCurrLocalToFrustumTransformCP () const
 Retrieve a pointer to the the transform from the current local coordinate system into DgnCoordSystem::Frustum. More...
 
BentleyStatus GetCurrLocalToFrustumTrans (TransformR trans) const
 Retrieve a copy of the transform from the current local coordinate system into DgnCoordSystem::Frustum. More...
 
BentleyStatus GetCurrFrustumToLocalTrans (TransformR trans) const
 Retrieve a copy of the transform from the DgnCoordSystem::Frustum to current local coordinate system. More...
 
BentleyStatus GetLocalToFrustumTrans (TransformR trans, size_t index) const
 Retrieve a copy of the transform from the local coordinate system at the specified index into DgnCoordSystem::Frustum. More...
 
double GetPixelSizeAtPoint (DPoint3dCP origin) const
 Calculate the size of a "pixel" at a given point in the current local coordinate system. More...
 
bool IsViewIndependent ()
 Check whether the current transform is view independent. More...
 
Pushing and Popping Tranforms and Clips
void PushTransform (TransformCR trans)
 Push a Transform. More...
 
Pushing and Popping Cand Clips
void PushClip (ClipVectorCR clip)
 Push a ClipVector. More...
 
void PushClipPlanes (ClipPlaneSetCR clipPlanes)
 Push a Transform and (optionally) a set of clip planes., creating a new local coordinate system and clip region. More...
 
void PushViewIndependentOrigin (DPoint3dCP origin)
 Push a transform such that the X,Y plane of the new local coordinate system will be aligned with the X,Y plane of the view coordinate system, oriented about the given origin. More...
 
StatusInt PushActiveTransform (TransformCR trans)
 Push a Transform in master coordinates, creating a new local coordinate system and clip region. More...
 
void PopTransformClip ()
 Remove the most recently pushed coordinate system and clip, restoring the local coordinate system to its previous state. More...
 
Query Methods
ViewFlagsCP GetViewFlags () const
 Get the current state of the ViewFlags for this context's output, can be NULL. More...
 
void SetViewFlags (ViewFlagsCP)
 Sets the current state of the ViewFlags for this context's output. More...
 
DgnModelRefP GetCurrentModel () const
 Get the current DgnModelRefP for this ViewContext. More...
 
DrawPurpose GetDrawPurpose () const
 Get the DrawPurpose specified when this ViewContext was attached to the current Viewport. More...
 
ViewportP GetViewport () const
 Get the Viewport to which this ViewContext is attached. More...
 
bool Is3dView () const
 Return true if view is 3d. More...
 
bool IsCameraOn () const
 Return true if view is a camera view. More...
 
DisplayPathCP GetCurrDisplayPath () const
 Get the current DisplayPath for this ViewContext. More...
 
DisplayPathCP GetSourceDisplayPath () const
 Get the source DisplayPath for this ViewContext. More...
 
Get/Set Current Display Parameters
UInt32 GetCurrLineColor ()
 Get current line color accounting for overrides. More...
 
UInt32 GetCurrFillColor ()
 Get current fill color accounting for overrides. More...
 
UInt32 GetCurrWidth ()
 Get current raster width accounting for overrides. More...
 
double GetDisplayPriority () const
 Calculate the display priority value for a given element. More...
 
LevelClassMaskGetLevelClassMask ()
 Get the current LevelClassMask for this context. More...
 
ElemMatSymbP GetElemMatSymb ()
 Get the current ElemMatSymb. More...
 
OvrMatSymbP GetOverrideMatSymb ()
 Get the current OvrMatSymb . More...
 
ElemDisplayParamsP GetCurrentDisplayParams ()
 Get the current ElemDisplayParams. More...
 
void CookDisplayParams ()
 Change the current "natural" ElemDisplayParams. More...
 
void CookDisplayParamsOverrides ()
 Change the current ElemDisplayParams for any context overrides. More...
 
void CookElemDisplayParams (ElementHandleCR element)
 Perform the full operation of extracting the ElemDisplayParams from an element then calling CookDisplayParams and CookDisplayParamsOverrides. More...
 
void ActivateOverrideMatSymb ()
 Change the Override ElemMatSymb for this context. More...
 
UInt32 GetIndexedColor (int index)
 Do a color lookup in the current color table. More...
 
UInt32 GetIndexedLineWidth (int index)
 Do a line width lookup in the current lineweight to width table. More...
 
UInt32 GetIndexedLinePattern (int index)
 Get the 32 bit on-off "line pattern" for a line code value for this context. More...
 
void SetIndexedLineColor (ElemMatSymbR elemMatSymb, int index)
 Set the line color in the given material from the given color index. More...
 
void SetIndexedFillColor (ElemMatSymbR elemMatSymb, int index)
 Set the fill color in the given material from the given color index. More...
 
void SetIndexedLineWidth (ElemMatSymbR elemMatSymb, int index)
 Set the line width in the given material from the given color index. More...
 
void SetIndexedLinePattern (ElemMatSymbR elemMatSymb, int index)
 Set the line pattern in the given material from the given color index. More...
 
void SetIndexedLineColor (OvrMatSymbR ovrMatSymb, int index)
 Set the line color in the given override material from the given color index. More...
 
void SetIndexedFillColor (OvrMatSymbR ovrMatSymb, int index)
 Set the fill color in the given override material from the given color index. More...
 
void SetIndexedLineWidth (OvrMatSymbR ovrMatSymb, int index)
 Set the line width in the given override material from the given color index. More...
 
void SetIndexedLinePattern (OvrMatSymbR ovrMatSymb, int index)
 Set the line pattern in the given override material from the given color index. More...
 
void SetLocatePriority (int priority)
 Set the locate priority for displayed geometry. More...
 
void SetNonSnappable (bool unsnappable)
 Set geometry displayed to this view to be non-snappable. More...
 
Methods to Retrieve Related Interfaces from a ViewContext
IViewDrawR GetIViewDraw ()
 Get the IViewDraw interface for this ViewContext. More...
 
IDrawGeomR GetIDrawGeom ()
 Get the IDrawGeom interface for this ViewContext. More...
 
ICachedDrawP GetICachedDraw ()
 Get the ICachedDraw interface for this ViewContext. More...
 
bool CheckICachedDraw ()
 Check whether we are creating a cached presentation. More...
 
Draw Geometry Using Current Linestyle
void DrawStyledLineString2d (int nPts, DPoint2dCP pts, double zDepth, DPoint2dCP range, bool closed=false)
 Draw a 2D linestring using the current Linestyle, if any. More...
 
void DrawStyledLineString3d (int nPts, DPoint3dCP pts, DPoint3dCP range, bool closed=false)
 Draw a 3D linestring using the current Linestyle, if any. More...
 
void DrawStyledArc2d (DEllipse3dCR ellipse, bool isEllipse, double zDepth, DPoint2dCP range)
 Draw a 2D elliptical arc using the current Linestyle. More...
 
void DrawStyledArc3d (DEllipse3dCR ellipse, bool isEllipse, DPoint3dCP range)
 Draw a 3D elliptical arc using the current Linestyle. More...
 
void DrawStyledBSplineCurve2d (MSBsplineCurveCR curve, double zDepth)
 Draw a 2d BSpline curve using the current Linestyle. More...
 
void DrawStyledBSplineCurve3d (MSBsplineCurveCR curve)
 Draw a BSpline curve using the current Linestyle. More...
 
void DrawStyledCurveVector3d (CurveVectorCR curve)
 Draw a curve vector using the current Linestyle. More...
 
void DrawStyledCurveVector2d (CurveVectorCR curve, double zDepth)
 Draw a 2d curve vector using the current Linestyle. More...
 
void DrawScanRange (ScanRange const *, bool is3d, UInt32 color)
 Draw ScanRange box. More...
 
void DrawElementRange (MSElementCP)
 Draw element range box. More...
 
void DrawTextString (TextStringCR)
 Draw a text string and any adornments such as background shape, underline, overline, etc. Sets up current ElemDisplayParams for TextString symbology. More...
 
void DrawTextBlock (TextBlockCR)
 Draw a text block with all lines and formatting. More...
 
bool CheckStop ()
 Check for abort. More...
 

Detailed Description

Remarks
Required library : DgnPlatform<ApiNumber>.lib i.e. DgnPlatform5.lib

Member Function Documentation

void ActivateOverrideMatSymb ( )

Change the Override ElemMatSymb for this context.

bool CheckICachedDraw ( )

Check whether we are creating a cached presentation.

Returns
true if we're in the process of creating a cache presentation.
bool CheckStop ( )

Check for abort.

void CookDisplayParams ( )

Change the current "natural" ElemDisplayParams.

Resolves effective symbology as required by the context and initializes the current ElemMatSymb.

Note
Calls ActivateMatSymb on the output.
void CookDisplayParamsOverrides ( )

Change the current ElemDisplayParams for any context overrides.

Cooks the modified ElemDisplayParams into the current OvrMatSymb.

Note
Does not call ActivateOverrideMatSymb.
void CookElemDisplayParams ( ElementHandleCR  element)

Perform the full operation of extracting the ElemDisplayParams from an element then calling CookDisplayParams and CookDisplayParamsOverrides.

Parameters
[in]elementThe element to cook and output
Note
Does not call ActivateOverrideMatSymb.
Remarks
Called from VisitElemHandle, rarely necessary for applications to call directly.
void DrawElementRange ( MSElementCP  )

Draw element range box.

void DrawScanRange ( ScanRange const *  ,
bool  is3d,
UInt32  color 
)

Draw ScanRange box.

void DrawStyledArc2d ( DEllipse3dCR  ellipse,
bool  isEllipse,
double  zDepth,
DPoint2dCP  range 
)

Draw a 2D elliptical arc using the current Linestyle.

If there is no current Linestyle, draw a solid arc.

Parameters
[in]ellipseThe arc data.
[in]isEllipseTreat full sweep as ellipse not arc.
[in]zDepthZ depth value.
[in]rangeArray of 2 points with the range (min followed by max) of the arc. This argument is optional and is only used to speed processing. If you do not already have the range, pass NULL.
void DrawStyledArc3d ( DEllipse3dCR  ellipse,
bool  isEllipse,
DPoint3dCP  range 
)

Draw a 3D elliptical arc using the current Linestyle.

If there is no current Linestyle, draw a solid arc.

Parameters
[in]ellipseThe arc data.
[in]isEllipseTreat full sweep as ellipse not arc.
[in]rangeArray of 2 points with the range (min followed by max) of the arc. This argument is optional and is only used to speed processing. If you do not already have the range, pass NULL.
void DrawStyledBSplineCurve2d ( MSBsplineCurveCR  curve,
double  zDepth 
)

Draw a 2d BSpline curve using the current Linestyle.

If there is no current Linestyle, draw a solid BSpline.

Parameters
curvebspline curve parameters
[in]zDepthZ depth value.
void DrawStyledBSplineCurve3d ( MSBsplineCurveCR  curve)

Draw a BSpline curve using the current Linestyle.

If there is no current Linestyle, draw a solid BSpline.

Parameters
curvebspline curve parameters
void DrawStyledCurveVector2d ( CurveVectorCR  curve,
double  zDepth 
)

Draw a 2d curve vector using the current Linestyle.

If there is no current Linestyle, draw a solid curve vector.

Parameters
curvecurve geometry
[in]zDepthZ depth value.
void DrawStyledCurveVector3d ( CurveVectorCR  curve)

Draw a curve vector using the current Linestyle.

If there is no current Linestyle, draw a solid curve vector.

Parameters
curvecurve geometry
void DrawStyledLineString2d ( int  nPts,
DPoint2dCP  pts,
double  zDepth,
DPoint2dCP  range,
bool  closed = false 
)

Draw a 2D linestring using the current Linestyle, if any.

If there is no current Linestyle, draw a solid linestring.

Parameters
[in]nPtsNumber of vertices in pts.
[in]ptsArray of points in linestring.
[in]zDepthDisplay priority for all vertices.
[in]rangeArray of 2 points with the range (min followed by max) of the vertices in points. This argument is optional and is only used to speed processing. If you do not already have the range of your points, pass NULL.
[in]closedDo point represent a shape or linestring.
void DrawStyledLineString3d ( int  nPts,
DPoint3dCP  pts,
DPoint3dCP  range,
bool  closed = false 
)

Draw a 3D linestring using the current Linestyle, if any.

If there is no current Linestyle, draw a solid linestring.

Parameters
[in]nPtsNumber of vertices in pts.
[in]ptsArray of points in linestring
[in]rangeArray of 2 points with the range (min followed by max) of the vertices in points. This argument is optional and is only used to speed processing. If you do not already have the range of your points, pass NULL.
[in]closedDo point represent a shape or linestring.
void DrawTextBlock ( TextBlockCR  )

Draw a text block with all lines and formatting.

void DrawTextString ( TextStringCR  )

Draw a text string and any adornments such as background shape, underline, overline, etc. Sets up current ElemDisplayParams for TextString symbology.

void FrustumToLocal ( DPoint3dP  localPts,
DPoint3dCP  frustumPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::Frustum into the current local coordinate system.

Parameters
[out]localPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]frustumPtsInput array in DgnCoordSystem::Frustum.
[in]nPtsNumber of points in both arrays.
void FrustumToView ( DPoint4dP  viewPts,
DPoint3dCP  frustumPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::Frustum into DgnCoordSystem::View.

Parameters
[out]viewPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]frustumPtsInput array in DgnCoordSystem::Frustum.
[in]nPtsNumber of points in both arrays.
void FrustumToView ( Point2d viewPts,
DPoint3dCP  frustumPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::Frustum into DgnCoordSystem::View.

Parameters
[out]viewPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]frustumPtsInput array in DgnCoordSystem::Frustum.
[in]nPtsNumber of points in both arrays.
DisplayPathCP GetCurrDisplayPath ( ) const

Get the current DisplayPath for this ViewContext.

The current DisplayPath changes as the ViewContext navigates through a model. It can be used to tell the path from the Root model through parent ElementRefs to the current ElementRefP (e.g. for components of shared cells.)

Returns
the current DisplayPath for this ViewContext.
Note
see discussion of DisplayPaths in the MDL documentation.
ElemDisplayParamsP GetCurrentDisplayParams ( )

Get the current ElemDisplayParams.

Returns
the current ElemDisplayParams.
DgnModelRefP GetCurrentModel ( ) const

Get the current DgnModelRefP for this ViewContext.

When a ViewContext is first attached to a Viewport, the current DgnModelRefP is the Root model of the Viewport. However, traversing the references for a Viewport the current model changes.

Returns
the current DgnModelRefP for this ViewContext
UInt32 GetCurrFillColor ( )

Get current fill color accounting for overrides.

BentleyStatus GetCurrFrustumToLocalTrans ( TransformR  trans) const

Retrieve a copy of the transform from the DgnCoordSystem::Frustum to current local coordinate system.

Parameters
[out]transTransform from DgnCoordSystem::Frustum to current local coordinate system
Returns
SUCCESS if there is a current local coordinate system.
UInt32 GetCurrLineColor ( )

Get current line color accounting for overrides.

BentleyStatus GetCurrLocalToFrustumTrans ( TransformR  trans) const

Retrieve a copy of the transform from the current local coordinate system into DgnCoordSystem::Frustum.

Parameters
[out]transTransform from current local coordinate system to DgnCoordSystem::Frustum
Returns
SUCCESS if there is a current local coordinate system.
TransformCP GetCurrLocalToFrustumTransformCP ( ) const

Retrieve a pointer to the the transform from the current local coordinate system into DgnCoordSystem::Frustum.

Returns
NULL if no transform present.
UInt32 GetCurrWidth ( )

Get current raster width accounting for overrides.

double GetDisplayPriority ( ) const

Calculate the display priority value for a given element.

Display priority is based on the priority value stored in the element header, the priority value of the element's level, and the priority value of the current model.

Returns
the display priority for element. For 3D views, display priority is always 0.
DrawPurpose GetDrawPurpose ( ) const

Get the DrawPurpose specified when this ViewContext was attached to the current Viewport.

Returns
the DrawPurpose specified in the call to DrawContext::Attach (drawcontext.h)
ElemMatSymbP GetElemMatSymb ( )

Get the current ElemMatSymb.

Returns
the current ElemMatSymb. 
ICachedDrawP GetICachedDraw ( )

Get the ICachedDraw interface for this ViewContext.

Returns
the ICachedDraw for this context.
IDrawGeomR GetIDrawGeom ( )

Get the IDrawGeom interface for this ViewContext.

Applications should use this method to draw geometry in Draw methods.

Returns
the IDrawGeom for this context
UInt32 GetIndexedColor ( int  index)

Do a color lookup in the current color table.

Parameters
[in]indexColor table index value between 0 and 255.
Returns
RGBA value for index from current color table.
UInt32 GetIndexedLinePattern ( int  index)

Get the 32 bit on-off "line pattern" for a line code value for this context.

Output devices can change the on-off patterns based on resolution, etc.

Parameters
[in]indexa the range of 0 to 7.
Returns
the line pattern value.
UInt32 GetIndexedLineWidth ( int  index)

Do a line width lookup in the current lineweight to width table.

Parameters
[in]indexLine weight between 0 and 31.
Returns
line width in pixels
IViewDrawR GetIViewDraw ( )

Get the IViewDraw interface for this ViewContext.

Usually, but not always, this will be the IViewDraw from the viewport to which this context is attached.

Returns
the IViewDraw for this context
LevelClassMask* GetLevelClassMask ( )

Get the current LevelClassMask for this context.

When a ViewContext is first attached, the LevelClassMask is initialized from the Viewport. However, during the course of an operation the LevelClassMask in the context may be changed from its initial value.

Returns
the current LevelClassMask for this ViewContext.
BentleyStatus GetLocalToFrustumTrans ( TransformR  trans,
size_t  index 
) const

Retrieve a copy of the transform from the local coordinate system at the specified index into DgnCoordSystem::Frustum.

Parameters
[out]transTransform from local coordinate system at the specified index to DgnCoordSystem::Frustum
[in]indexIndex into transform stack to return transform for.
Returns
SUCCESS if there is a local coordinate system.
OvrMatSymbP GetOverrideMatSymb ( )

Get the current OvrMatSymb .

Returns
the current OvrMatSymb.
double GetPixelSizeAtPoint ( DPoint3dCP  origin) const

Calculate the size of a "pixel" at a given point in the current local coordinate system.

This method can be used to approximate how large geometry in local coordinates will appear in DgnCoordSystem::View units.

Parameters
[in]originThe point at which the pixel size is calculated. This point is only relevant in camera views, where local coordinates closer to the eye are larger than those further from the eye. May be NULL, in which case the center of the view is used.
Returns
the length, in the current coordinate system units, of a unit bvector in the x direction in DgnCoordSystem::View, starting at origin.
ClipPlaneSetCP GetRangePlanes ( ) const

Get the clip planes that define the limits of the displayed volume.

This will include planes for the top,bottom,left and right sides of the view and optionally the front and back planes if they are enabled.

Returns
the clip planes set.
DisplayPathCP GetSourceDisplayPath ( ) const

Get the source DisplayPath for this ViewContext.

The "source" DisplayPath will only be non-NULL when the context is being used to "re-display" an existing path. During Updates, for example, the source DisplayPath will be NULL.

Returns
the DisplayPath for this ViewContext.
Note
see discussion of DisplayPaths in the MDL documentation.
ViewFlagsCP GetViewFlags ( ) const

Get the current state of the ViewFlags for this context's output, can be NULL.

When a ViewContext is first attached to a Viewport, the ViewFlags are initialized from the Viewport's viewflags. However, during the course of an operation, the viewflags for the output may be different than those on the Viewport.

Returns
the current state of the viewflags for this ViewContext.
ViewportP GetViewport ( ) const

Get the Viewport to which this ViewContext is attached.

ViewContext's do not always have to be attached to an Viewport, so therefore callers must always test the result of this call for NULL.

Returns
the Viewport. NULL if not attached to a Viewport.
bool Is3dView ( ) const

Return true if view is 3d.

bool IsCameraOn ( ) const

Return true if view is a camera view.

bool IsViewIndependent ( )

Check whether the current transform is view independent.

Several MicroStation element types can display as "View independent" (e.g. text, text nodes, point cells). They do this by pushing the inverse of the current view-to-local transformation via PushViewIndependentOrigin.

Returns
true if the current local coordinate system is a view independent transform.
void LocalToFrustum ( DPoint3dP  frustumPts,
DPoint3dCP  localPts,
int  nPts 
) const

Transfrom an array of points in the current local coordinate system into DgnCoordSystem::Frustum coordinates.

Parameters
[out]frustumPtsAn array to receive the points in DgnCoordSystem::Frustum. Must be dimensioned to hold nPts points.
[in]localPtsInput array in current local coordinates,
[in]nPtsNumber of points in both arrays.
void LocalToView ( DPoint4dP  viewPts,
DPoint3dCP  localPts,
int  nPts 
) const

Transfrom an array of points in the current local coordinate system into DgnCoordSystem::View coordinates.

Parameters
[out]viewPtsAn array to receive the points in DgnCoordSystem::View. Must be dimensioned to hold nPts points.
[in]localPtsInput array in current local coordinates,
[in]nPtsNumber of points in both arrays.
void LocalToView ( DPoint3dP  viewPts,
DPoint3dCP  localPts,
int  nPts 
) const

Transfrom an array of points in the current local coordinate system into DgnCoordSystem::View coordinates.

Parameters
[out]viewPtsAn array to receive the points in DgnCoordSystem::View. Must be dimensioned to hold nPts points.
[in]localPtsInput array in current local coordinates,
[in]nPtsNumber of points in both arrays.
void NpcToFrustum ( DPoint3dP  frustumPts,
DPoint3dCP  npcPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::Npc into DgnCoordSystem::Frustum.

Parameters
[out]frustumPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]npcPtsInput array in DgnCoordSystem::Npc.
[in]nPtsNumber of points in both arrays.
void NpcToView ( DPoint3dP  viewPts,
DPoint3dCP  npcPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::Npc into DgnCoordSystem::View.

Parameters
[out]viewPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]npcPtsInput array in DgnCoordSystem::Npc.
[in]nPtsNumber of points in both arrays.
ElementRefP PopPath ( )
void PopTransformClip ( )

Remove the most recently pushed coordinate system and clip, restoring the local coordinate system to its previous state.

StatusInt PushActiveTransform ( TransformCR  trans)

Push a Transform in master coordinates, creating a new local coordinate system and clip region.

Parameters
[in]transthe transform to push. May be NULL.
See also
PopTransformClip
void PushClip ( ClipVectorCR  clip)

Push a ClipVector.

Parameters
[in]clipA clipping vector to push. The clip region is the intersection of all clipPrimitives in the vector.
See also
PopTransformClip
void PushClipPlanes ( ClipPlaneSetCR  clipPlanes)

Push a Transform and (optionally) a set of clip planes., creating a new local coordinate system and clip region.

Parameters
[in]clipPlanesClipping planes to push. The clip region is the union of all convex sets in the set.
See also
PopTransformClip
void PushPath ( ElementRefP  elemRef)
void PushTransform ( TransformCR  trans)

Push a Transform.

Parameters
[in]transTransform to push.
See also
PopTransformClip
void PushViewIndependentOrigin ( DPoint3dCP  origin)

Push a transform such that the X,Y plane of the new local coordinate system will be aligned with the X,Y plane of the view coordinate system, oriented about the given origin.

Parameters
[in]originOrigin for rotation, in the current local coordinate system.
void SetIndexedFillColor ( ElemMatSymbR  elemMatSymb,
int  index 
)

Set the fill color in the given material from the given color index.

method instead of modifying ElemMatSymb directly.

Parameters
[in]elemMatSymbElemMatSymb in which to change the fill color.
[in]indexColor table index value between 0 and 255.
Note
This is just a helper method that calls ElemMatSymb::SetIndexedFillColorTBGR.
void SetIndexedFillColor ( OvrMatSymbR  ovrMatSymb,
int  index 
)

Set the fill color in the given override material from the given color index.

Parameters
[in]ovrMatSymbOvrMatSymb in which to change the fill color.
[in]indexColor table index value between 0 and 255.
Note
This is just a helper method that calls OvrMatSymb::SetIndexedFillColorTBGR.
void SetIndexedLineColor ( ElemMatSymbR  elemMatSymb,
int  index 
)

Set the line color in the given material from the given color index.

Parameters
[in]elemMatSymbElemMatSymb in which to change the line color.
[in]indexColor table index value between 0 and 255.
Note
This is just a helper method that calls ElemMatSymb::SetIndexedLineColorTBGR.
void SetIndexedLineColor ( OvrMatSymbR  ovrMatSymb,
int  index 
)

Set the line color in the given override material from the given color index.

Parameters
[in]ovrMatSymbOvrMatSymb in which to change the line color.
[in]indexColor table index value between 0 and 255.
Note
This is just a helper method that calls OvrMatSymb::SetIndexedLineColorTBGR.
void SetIndexedLinePattern ( ElemMatSymbR  elemMatSymb,
int  index 
)

Set the line pattern in the given material from the given color index.

Parameters
[in]elemMatSymbElemMatSymb in which to change the line pattern.
[in]indexLine style index between 0 and 7.
Note
This is just a helper method that calls ElemMatSymb::SetIndexedRasterPattern.
void SetIndexedLinePattern ( OvrMatSymbR  ovrMatSymb,
int  index 
)

Set the line pattern in the given override material from the given color index.

Parameters
[in]ovrMatSymbOvrMatSymb in which to change the line pattern.
[in]indexLine style index between 0 and 7.
Note
This is just a helper method that calls OvrMatSymb::SetIndexedRasterPattern.
void SetIndexedLineWidth ( ElemMatSymbR  elemMatSymb,
int  index 
)

Set the line width in the given material from the given color index.

Parameters
[in]elemMatSymbElemMatSymb in which to change the line width.
[in]indexLine weight between 0 and 31.
Note
This is just a helper method that calls ElemMatSymb::SetWidth
void SetIndexedLineWidth ( OvrMatSymbR  ovrMatSymb,
int  index 
)

Set the line width in the given override material from the given color index.

Parameters
[in]ovrMatSymbOvrMatSymb in which to change the line width.
[in]indexLine weight between 0 and 31.
Note
This is just a helper method that calls OvrMatSymb::SetWidth.
void SetLocatePriority ( int  priority)

Set the locate priority for displayed geometry.

Parameters
[in]priorityHit Priority
void SetNonSnappable ( bool  unsnappable)

Set geometry displayed to this view to be non-snappable.

Parameters
[in]unsnappableThe non-snappable status.
void SetViewFlags ( ViewFlagsCP  )

Sets the current state of the ViewFlags for this context's output.

void ViewToFrustum ( DPoint3dP  frustumPts,
DPoint4dCP  viewPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::View into DgnCoordSystem::Frustum.

Parameters
[out]frustumPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]viewPtsInput array in DgnCoordSystem::View.
[in]nPtsNumber of points in both arrays.
void ViewToFrustum ( DPoint3dP  frustumPts,
DPoint3dCP  viewPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::View into DgnCoordSystem::Frustum.

Parameters
[out]frustumPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]viewPtsInput array in DgnCoordSystem::View.
[in]nPtsNumber of points in both arrays.
void ViewToLocal ( DPoint3dP  localPts,
DPoint4dCP  viewPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::View into the current local coordinate system.

Parameters
[out]localPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]viewPtsInput array in DgnCoordSystem::View.
[in]nPtsNumber of points in both arrays.
void ViewToLocal ( DPoint3dP  localPts,
DPoint3dCP  viewPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::View into the current local coordinate system.

Parameters
[out]localPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]viewPtsInput array in DgnCoordSystem::View.
[in]nPtsNumber of points in both arrays.
void ViewToNpc ( DPoint3dP  npcPts,
DPoint3dCP  viewPts,
int  nPts 
) const

Transfrom an array of points in DgnCoordSystem::View into DgnCoordSystem::Npc.

Parameters
[out]npcPtsAn array to receive the transformed points. Must be dimensioned to hold nPts points.
[in]viewPtsInput array in DgnCoordSystem::View.
[in]nPtsNumber of points in both arrays.
StatusInt VisitElemHandle ( ElementHandleCR  ,
bool  checkRange,
bool  checkScanCriteria 
)
StatusInt VisitTransient ( ElementHandleCR  ,
SymbologyOverridesP   
)

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

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