Modules
	FenceProcessing

Namespaces
	Bentley
	The Bentley namespace contains types defined by the Bentley Library.

Classes
struct	FenceParams
	Class for finding elements that are inside or overlap a volume defined by an extrusion of a planar region profile. More...

Enumerations
enum	FenceClipMode { None = 0, Original = 1, Copy = 3 }
	The fence clip mode controls element acceptance criteria. More...

Functions
DGNPLATFORM_EXPORT void	SetViewParams (ViewportP)
	Setup the fence parameters from the supplied viewport. More...

DGNPLATFORM_EXPORT void	SetModelRef (DgnModelRefP)
	Set the fence destination model. More...

DGNPLATFORM_EXPORT void	SetOverlapMode (bool mode)
	Set fence mode to inside or overlap for when the clip model is none. More...

DGNPLATFORM_EXPORT void	SetClipMode (FenceClipMode)
	Set the fence clip mode. More...

DGNPLATFORM_EXPORT void	SetClip (ClipVectorCR clip)
	Set the fence boundary by supplying a ClipVector. More...

DGNPLATFORM_EXPORT void	SetTransform (TransformCR)
	Set the current fence to root transform. This is normally set by calling SetViewParams. More...

DGNPLATFORM_EXPORT void	SetLocateInteriors (LocateSurfacesPref)
	Specify whether overlap testing should detect a fence that is completely contained within a region/surface element. More...

DGNPLATFORM_EXPORT StatusInt	StoreClippingPoints (bool outside, DPoint2dP, int nPoints)
	Setup the fence clip boundary from 2d clipping points. Pass true for blockIfPossible to create CLIPBLOCK instead of CLIPSHAPE when points define a rectangle. More...

DGNPLATFORM_EXPORT StatusInt	StoreClippingElement (ElementHandleCR, bool outside)
	Setup the fence clip boundary from an element that represents a planar region or simple extruded volume. More...

DGNPLATFORM_EXPORT void	ClippingPointsFromRootPoints (DPoint2dP, DPoint3dP, int numPts, ViewportP)
	Return 2d clipping points suitable for calling StoreClippingPoints from 3d input points in the coordinates of the view's root model. More...

DGNPLATFORM_EXPORT bool	IsCameraOn () const
	Return true if fence was defined by 2d points in a camera view. More...

DGNPLATFORM_EXPORT double	GetFocalLength () const
	Return camera focal length, only valid when IsCameraOn returns true. More...

DGNPLATFORM_EXPORT DgnModelRefP	GetModelRef () const
	Return current fence model. More...

DGNPLATFORM_EXPORT ClipVectorPtr	GetClipVector () const
	Return a pointer to the fence's clip boundary. More...

DGNPLATFORM_EXPORT FenceClipMode	GetClipMode () const
	Return current fence clip mode. More...

DGNPLATFORM_EXPORT ViewportP	GetViewport () const
	Return current fence viewport. More...

DGNPLATFORM_EXPORT TransformP	GetTransform ()
	Return current fence to root transform. More...

DGNPLATFORM_EXPORT bool	PointInside (DPoint3dCR)
	Return true if the supplied point is inside the fence. More...

DGNPLATFORM_EXPORT bool	HasOverlaps () const
	Return true if AcceptElement detected an overlap. More...

DGNPLATFORM_EXPORT bool	AllowOverlaps () const
	Return true if fence overlap mode is set. More...

DGNPLATFORM_EXPORT StatusInt	SetToModelRef (DgnModelRefP)
	Push view clipping (for a root model) and DgnAttachment transform/clipping onto the fence. More...

DGNPLATFORM_EXPORT bool	AcceptElement (ElementHandleCR)
	Return true if the given element satisfies the fence criteria. More...

DGNPLATFORM_EXPORT BentleyStatus	BuildAgenda (ElementAgendaR agenda, DgnModelRefListP searchList)

static DGNPLATFORM_EXPORT FenceParamsP	Create (DgnModelRefP)
	Create a new instance of FenceParams. More...

static DGNPLATFORM_EXPORT void	Delete (FenceParamsP)
	Frees a FenceParams instance. More...

Detailed Description

Enumeration Type Documentation

enum FenceClipMode

strong

The fence clip mode controls element acceptance criteria.

A clip mode of none returns only elements inside the fence when overlaps aren't requested. A clip mode of original or copy always returns overlapping elements. The actual clip behavior varies according to the fence operation, ex. delete, move, copy.

Enumerator
None	Inclusion of inside/overlapping elements controlled by overlap mode. No clipping of elements satisfying the fence criteria.
Original	Include elements that overlap the fence. Tools will modify the original element.
Copy	Include elements that overlap the fence. Tools will not modify the original element.

Function Documentation

DGNPLATFORM_EXPORT bool AcceptElement ( ElementHandleCR )

Return true if the given element satisfies the fence criteria.

DGNPLATFORM_EXPORT bool AllowOverlaps ( ) const

Return true if fence overlap mode is set.

DGNPLATFORM_EXPORT BentleyStatus BuildAgenda	(	ElementAgendaR	agenda,
		DgnModelRefListP	searchList
	)

Parameters

[out]	agenda	The list of elements that satisfied the fence criteria.
[in]	searchList	The list of candidate models to search for elements that pass the fence criteria.

Returns: SUCCESS If one or more elements were found that satisfied the fence criteria.

Note: Populates agenda with un-clipped elements that satisfy the fence criteria. Set overlap mode to false and clip mode to none to collect only those elements completely inside the fence, otherwise both inside and overlapping elements are collected.

DGNPLATFORM_EXPORT void ClippingPointsFromRootPoints	(	DPoint2dP	,
		DPoint3dP	,
		int	numPts,
		ViewportP
	)

Return 2d clipping points suitable for calling StoreClippingPoints from 3d input points in the coordinates of the view's root model.

static DGNPLATFORM_EXPORT FenceParamsP Create ( DgnModelRefP )

static

Create a new instance of FenceParams.

static DGNPLATFORM_EXPORT void Delete ( FenceParamsP )

static

Frees a FenceParams instance.

DGNPLATFORM_EXPORT FenceClipMode GetClipMode ( ) const

Return current fence clip mode.

DGNPLATFORM_EXPORT ClipVectorPtr GetClipVector ( ) const

Return a pointer to the fence's clip boundary.

DGNPLATFORM_EXPORT double GetFocalLength ( ) const

Return camera focal length, only valid when IsCameraOn returns true.

DGNPLATFORM_EXPORT DgnModelRefP GetModelRef ( ) const

Return current fence model.

DGNPLATFORM_EXPORT TransformP GetTransform ( )

Return current fence to root transform.

DGNPLATFORM_EXPORT ViewportP GetViewport ( ) const

Return current fence viewport.

DGNPLATFORM_EXPORT bool HasOverlaps ( ) const

Return true if AcceptElement detected an overlap.

DGNPLATFORM_EXPORT bool IsCameraOn ( ) const

Return true if fence was defined by 2d points in a camera view.

DGNPLATFORM_EXPORT bool PointInside ( DPoint3dCR )

Return true if the supplied point is inside the fence.

DGNPLATFORM_EXPORT void SetClip ( ClipVectorCR clip )

Set the fence boundary by supplying a ClipVector.

DGNPLATFORM_EXPORT void SetClipMode ( FenceClipMode )

Set the fence clip mode.

DGNPLATFORM_EXPORT void SetLocateInteriors ( LocateSurfacesPref )

Specify whether overlap testing should detect a fence that is completely contained within a region/surface element.

DGNPLATFORM_EXPORT void SetModelRef ( DgnModelRefP )

Set the fence destination model.

DGNPLATFORM_EXPORT void SetOverlapMode ( bool mode )

Set fence mode to inside or overlap for when the clip model is none.

DGNPLATFORM_EXPORT StatusInt SetToModelRef ( DgnModelRefP )

Push view clipping (for a root model) and DgnAttachment transform/clipping onto the fence.

DGNPLATFORM_EXPORT void SetTransform ( TransformCR )

Set the current fence to root transform. This is normally set by calling SetViewParams.

DGNPLATFORM_EXPORT void SetViewParams ( ViewportP )

Setup the fence parameters from the supplied viewport.

DGNPLATFORM_EXPORT StatusInt StoreClippingElement	(	ElementHandleCR	,
		bool	outside
	)

Setup the fence clip boundary from an element that represents a planar region or simple extruded volume.

DGNPLATFORM_EXPORT StatusInt StoreClippingPoints	(	bool	outside,
		DPoint2dP	,
		int	nPoints
	)

Setup the fence clip boundary from 2d clipping points. Pass true for blockIfPossible to create CLIPBLOCK instead of CLIPSHAPE when points define a rectangle.

Modules

Namespaces

Classes

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

Function Documentation