The Associative Region cell can represent one or more planar regions that can be a shape, ellipse, complex shape, or grouped hole. More...

#include <AssocRegionHandler.h>

Inheritance diagram for AssocRegionCellHeaderHandler:

Static Public Member Functions
static DGNPLATFORM_EXPORT bool	IsValidRegionBoundaryType (ElementHandleCR eh)
	Check the supplied element to determine if it is an acceptable type for inclusion as part of a pre-computed region boundary loop. More...

static DGNPLATFORM_EXPORT BentleyStatus	SetLoopRoots (EditElementHandleR eeh, DependencyRoot const *boundaryRoots, size_t numBoundaryRoots)
	Add loop boundary dependencies to an element that represents a single closed pre-computed boundary loop. More...

static DGNPLATFORM_EXPORT BentleyStatus	SetLoopOedCode (EditElementHandleR eeh, int loopCode)
	Add a loop code type identifier to a pre-computed boundary element loop. More...

static DGNPLATFORM_EXPORT BentleyStatus	CreateAssocRegionElement (EditElementHandleR eeh, ElementAgendaR boundary, DependencyRoot const *boundaryRoots, size_t numBoundaryRoots, DPoint3dCP seedPoints, size_t numSeedPoints, RegionParams const &params, WCharCP cellName)
	Create a new associative region cell from the supplied parameters and pre-computed boundaries. More...

Static Public Member Functions inherited from DisplayHandler
static DisplayHandler &	GetInstance ()

static void	InitializeBasis (EditElementHandleR eh, TransformCR transform, DRange3dCP range)
	Initialize basis for an element - In most cases this should be done only once at creation. More...

Static Public Member Functions inherited from ITransactionHandler
static void	CallOnAdded (ElementHandleR)

static void	CallOnAddedComplete (ElementHandleR)

Static Public Member Functions inherited from ICurvePathQuery
static CurveVectorPtr	ElementToCurveVector (ElementHandleCR eh)
	Wrapper method that just dynamic casts handler to ICurvePathQuery and calls GetCurveVector. More...

static BentleyStatus	ElementToCurveVectors (ElementHandleCR eh, bvector< CurveVectorPtr > &curves)
	Return path curves as a bvector of CurveVector. More...

Additional Inherited Members
Public Member Functions inherited from DisplayHandler
void	GetPathDescription (ElementHandleCR el, WStringR string, DisplayPathCP path, WCharCP levelStr, WCharCP modelStr, WCharCP groupStr, WCharCP delimiterStr)
	Return a full description of the path to be used to inform the user which element is under consideration. More...

void	GetTransformOrigin (ElementHandleCR el, DPoint3dR origin)
	Get the Transform Origin for this element. More...

void	GetSnapOrigin (ElementHandleCR el, DPoint3dR origin)
	Get the snap origin for this element. More...

void	GetOrientation (ElementHandleCR el, RotMatrixR orientation)
	Get an "orientation" RotMatrix for this element. More...

bool	GetBasisTransform (ElementHandleCR eh, TransformR transform)
	Get an "basis" Transform for this element. More...

bool	GetBasisRange (ElementHandleCR eh, DRange3dR range)
	Get an basis Range for this element. More...

void	SetBasisRange (EditElementHandleR eh, DRange3dCR range)
	Set an basis Range for this element. More...

void	SetBasisTransform (EditElementHandleR eh, TransformCR transform)
	Set an basis Transform for this element. More...

bool	IsRenderable (ElementHandleCR el)
	Determine whether this element is renderable (i.e., subject to lighting). More...

bool	IsPlanar (ElementHandleCR el, DVec3dP normal, DPoint3dP point, DVec3dCP inputDefaultNormal)
	Test whether this element is planar. More...

bool	IsVisible (ElementHandleCR el, ViewContextR context, bool testRange, bool testLevel, bool testClass)
	Determine whether this element is visible in the supplied context. More...

StatusInt	Drop (ElementHandleCR eh, ElementAgendaR dropGeom, DropGeometryCR geometry)
	Drop this element to a group of (simpler) primitive elements. More...

Public Member Functions inherited from Handler
void	GetDescription (ElementHandleCR el, WStringR string, UInt32 desiredLength)
	Get a brief string describing the element. More...

void	GetTypeName (WStringR string, UInt32 desiredLength)
	Get the type name for this handler. More...

DisplayHandlerP	GetDisplayHandler ()
	Use this method instead of dynamic_cast<DisplayHandlerP> (handler) More...

ITransactionHandlerP	GetITransactionHandler ()
	Use this method instead of dynamic_cast<ITransactionHandlerP> (handler) More...

IDependencyHandlerP	GetIDependencyHandler ()
	Use this method instead of dynamic_cast<IDependencyHandlerP> (handler) More...

StatusInt	ApplyTransform (EditElementHandleR element, TransformInfoCR transform)
	Transform the element. More...

StatusInt	FenceStretch (EditElementHandleR element, TransformInfoCR transform, FenceParamsP fp, FenceStretchFlags options)
	The handler is requested to "stretch" the specified element, that is, to transform the portions of the element that meet the clip criteria. More...

StatusInt	FenceClip (ElementAgendaP inside, ElementAgendaP outside, ElementHandleCR element, FenceParamsP fp, FenceClipFlags options)
	The handler is requested to clip the specified element, that is, to return the portions of the element that are inside/outside the clip criteria. More...

void	ConvertTo3d (EditElementHandleR eeh, double elevation)
	Convert a 2d element to it's 3d form. More...

void	ConvertTo2d (EditElementHandleR eeh, TransformCR flattenTrans, DVec3dCR flattenDir)
	Convert a 3d element to it's 2d form. More...

void	QueryProperties (ElementHandleCR eh, PropertyContextR context)
	Method for enummerating the common properties of elements such as color and level. More...

void	EditProperties (EditElementHandleR eeh, PropertyContextR context)
	Method for changing the common properties of elements such as color and level. More...

bool	ExposeChildren (ElementHandleCR el, ExposeChildrenReason reason)
	Determine whether the children of this element should be exposed to the caller for the intended purpose. More...

Public Member Functions inherited from ICurvePathEdit
BentleyStatus	SetCurveVector (EditElementHandleR eeh, CurveVectorCR path)
	Update element from path curves. More...

Public Member Functions inherited from ICurvePathQuery
BentleyStatus	GetCurveVector (ElementHandleCR eh, CurveVectorPtr &curves)
	Return path curves as a bvector of ICurvePrimitive. More...

Public Member Functions inherited from IAssocRegionQuery
DGNPLATFORM_EXPORT BentleyStatus	GetParams (ElementHandleCR eh, RegionParams &params) const
	Query the region parameters of a region element. More...

DGNPLATFORM_EXPORT BentleyStatus	GetSeedPoints (ElementHandleCR eh, bvector< DPoint3d > *points) const
	Query the flood seed points for a flood type region. More...

DGNPLATFORM_EXPORT BentleyStatus	GetRoots (ElementHandleCR eh, bvector< DependencyRoot > *roots) const
	Query the dependency roots of a region element. More...

DGNPLATFORM_EXPORT BentleyStatus	GetLoopData (ElementHandleCR eh, bvector< LoopData > *loopData) const
	Query information for the loop boundaries of a region element. More...

Public Member Functions inherited from IAreaFillPropertiesEdit
DGNPLATFORM_EXPORT bool	SetAreaType (EditElementHandleR eeh, bool isHole)
	Change the current solid/hole status for the supplied element. More...

DGNPLATFORM_EXPORT bool	RemoveAreaFill (EditElementHandleR eeh)
	Remove the current solid or gradient fill from the supplied element. More...

DGNPLATFORM_EXPORT bool	RemovePattern (EditElementHandleR eeh, int index)
	Remove the current hatch or area pattern from the supplied element. More...

DGNPLATFORM_EXPORT bool	AddSolidFill (EditElementHandleR eeh, UInt32 fillColorP=NULL, bool alwaysFilledP=NULL)
	Add solid fill to the supplied element. More...

DGNPLATFORM_EXPORT bool	AddGradientFill (EditElementHandleR eeh, GradientSymbCR symb)
	Add gradient fill to the supplied element. More...

DGNPLATFORM_EXPORT bool	AddPattern (EditElementHandleR eeh, PatternParamsR params, DwgHatchDefLineP hatchDefLinesP, int index=0)
	Add a hatch or area pattern to the supplied element. More...

Public Member Functions inherited from IAreaFillPropertiesQuery
DGNPLATFORM_EXPORT bool	GetAreaType (ElementHandleCR eh, bool *isHoleP) const
	Query whether the area defined by a closed region represents a solid or hole. More...

DGNPLATFORM_EXPORT bool	GetSolidFill (ElementHandleCR eh, UInt32 fillColorP, bool alwaysFilledP) const
	Query the current solid fill information for the supplied element. More...

DGNPLATFORM_EXPORT bool	GetGradientFill (ElementHandleCR eh, GradientSymbPtr &symb) const
	Query the current gradient fill information for the supplied element. More...

DGNPLATFORM_EXPORT bool	GetPattern (ElementHandleCR eh, PatternParamsPtr &params, bvector< DwgHatchDefLine > *hatchDefLinesP, DPoint3dP originP, int index) const
	Query the current hatch or area pattern information for the supplied element. More...

Protected Types inherited from ITransactionHandler
enum	PreActionStatus { PRE_ACTION_Ok = 0, PRE_ACTION_Block = 1 }

Protected Member Functions inherited from ITransactionHandler
virtual void	_OnUndoRedo (ElementHandleP afterUndoRedo, ElementHandleP beforeUndoRedo, ChangeTrackAction action, bool isUndo, ChangeTrackSource source)
	Called when an element is changed by either the Undo or Redo command in MicroStation. More...

virtual void	_OnHistoryRestore (ElementHandleP after, ElementHandleP before, ChangeTrackAction actionStep, BentleyDgnHistoryElementChangeType effectiveChange)
	Called when an element is changed by design history to restore a historical version. More...

virtual void	_OnUndoRedoFinished (ElementRefP element, bool isUndo)
	Called after undo/redo has restored all elements involved in the transaction and after all undo/redo callbacks have been invoked. More...

virtual void	_OnDeleted (ElementHandleP element)
	Called after an element is deleted from a model. More...

virtual void	_OnAdded (ElementHandleP element)
	Called after an element is added to a model. More...

virtual void	_OnAddedComplete (ElementHandleP element)
	Called after an element is added to a model. More...

virtual void	_OnModified (ElementHandleP newElement, ElementHandleP oldElement, ChangeTrackAction action, bool *cantBeUndoneFlag)
	Called after an element is directly changed in MicroStation and the DgnModel holds the new state of the element. More...

virtual void	_OnUndoRedoXAttributeChange (XAttributeHandleCR xAttr, ChangeTrackAction action, bool isUndo, ChangeTrackSource source)
	Called whenever an XAttribute is changed by either the Undo or Redo command in MicroStation. More...

virtual void	_OnXAttributeChanged (XAttributeHandleCR xAttr, ChangeTrackAction action, bool *cantBeUndoneFlag)
	Called when an XAttribute has been added, removed, or modified on the element. More...

virtual PreActionStatus	_OnAdd (EditElementHandleR)

virtual PreActionStatus	_OnReplace (EditElementHandleR, ElementHandleCR)

virtual PreActionStatus	_OnDelete (ElementHandleCR)

virtual PreActionStatus	_OnRemoveHandler (ElementHandleCR)

Detailed Description

The Associative Region cell can represent one or more planar regions that can be a shape, ellipse, complex shape, or grouped hole.

The region boundaries can be visible or invisible and associated to other persistent elements such that they will update when changes are made to the boundary roots. The AssocRegionCellHeaderHandler supports area properties like fill, and hatching.

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

Member Function Documentation

static DGNPLATFORM_EXPORT BentleyStatus CreateAssocRegionElement	(	EditElementHandleR	eeh,
		ElementAgendaR	boundary,
		DependencyRoot const *	boundaryRoots,
		size_t	numBoundaryRoots,
		DPoint3dCP	seedPoints,
		size_t	numSeedPoints,
		RegionParams const &	params,
		WCharCP	cellName
	)

static

Create a new associative region cell from the supplied parameters and pre-computed boundaries.

Parameters

[out]	eeh	The new element.
[in]	boundary	Pre-computed boundary elements, requires a minimum of one.
[in]	boundaryRoots	Array of boundary root dependencies for all loops (required for region to be associative)
[in]	numBoundaryRoots	Number of boundary root entries
[in]	seedPoints	Seed point for flood type region.
[in]	numSeedPoints	Number of seed points.
[in]	params	Region parameters.
[in]	cellName	Name to use for region cell.

Returns: SUCCESS if a valid element is created and range was sucessfully calculated.

Note: boundary agenda entries will be invalid after this call unless they represent persistent elements as element descriptor are extracted.

Remarks: It is recommended that applications use DgnRegionElementTool to interactively create associative regions and RegionGraphicsContext to programmatically create them instead of trying to use this low-level create method directly.

static DGNPLATFORM_EXPORT bool IsValidRegionBoundaryType ( ElementHandleCR eh )

static

Check the supplied element to determine if it is an acceptable type for inclusion as part of a pre-computed region boundary loop.

Valid components are curves of the following types:

LINE_ELM
LINE_STRING_ELM
SHAPE_ELM
CURVE_ELM
CMPLX_STRING_ELM
CMPLX_SHAPE_ELM
ARC_ELM
ELLIPSE_ELM
BSPLINE_CURVE_ELM
CELL_HEADER_ELM that returns true from GroupedHoleHandler::IsGroupedHole.

Parameters

[in] eh The element to check.

Returns: true if element is valid candidate.

Note: The actual root element may be a piece of text, dimension, etc. But the pre-computed boundary elements must be open or closed curves.

Remarks: Loops are typically closed elements, patterning has support for open boundaries (for DWG support) which is why open elements are allowed.; This is a helper function for setting up a pre-computed boundary to supply to CreateAssocRegionElement.

static DGNPLATFORM_EXPORT BentleyStatus SetLoopOedCode	(	EditElementHandleR	eeh,
		int	loopCode
	)

static

Add a loop code type identifier to a pre-computed boundary element loop.

Parameters

[out]	eeh	A pre-computed boundary element loop.
[in]	loopCode	Loop type identifier code.

Returns: SUCCESS if loop code was added.

Remarks: This is a helper function for setting up a pre-computed boundary to supply to CreateAssocRegionElement.

static DGNPLATFORM_EXPORT BentleyStatus SetLoopRoots	(	EditElementHandleR	eeh,
		DependencyRoot const *	boundaryRoots,
		size_t	numBoundaryRoots
	)

static

Add loop boundary dependencies to an element that represents a single closed pre-computed boundary loop.

Parameters

[out]	eeh	A pre-computed boundary element loop.
[in]	boundaryRoots	Array of boundary root dependencies for just this loop.
[in]	numBoundaryRoots	Number of boundary root entries

Returns: SUCCESS if loop boundary roots were added.

Remarks: This is a helper function for setting up a pre-computed boundary to supply to CreateAssocRegionElement.

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

AssocRegionHandler.h

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation