ElementaryRegion2D Class Reference

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base class for all Region2D derived classes which are not composed. More...

Inheritance diagram for ElementaryRegion2D:

Public Member Functions
double	CalculateDistanceOfPointToRegionBorder (VectorD point)
	Calculates the distance of a point to the border of this region.
	ElementaryRegion2D (bool boundariesAreInside, PhysicalProperty propertyOfCoordinatesX=PhysicalProperty.Length, PhysicalProperty propertyOfCoordinatesY=PhysicalProperty.Length)
	Constructor which gets the _boundariesAreInside flag. To be called from derived classes constructors.
	ElementaryRegion2D (ElementaryRegion2D region2bCopied)
	Copy constructor.
Public Member Functions inherited from Region2D
void	CalculateAxisAlignedBoundingBox ()
	Method for (re)calculating the axis aligned bounding box.
override object	Clone ()
	Clones the current object.
override bool	Equals (object obj, EqualityIntent equalityIntent)
	Equality operation.
override int	GetHashCode ()
InsideOutside	GetInOutRelation (VectorD point, ExtrapolationInfo extrapolation2use=null)
	Method which checks whether or not a point lies inside or outside the 2D region or on its boundary.
override FormDocument	GetNewDocumentWindow (Form formMain, string fileName)
	Gets a new document window containing this document. Parameters formMain Reference to the main form (= MDI parent). Can be null if this form will not be shown (e.g. if it is generated just to get the view settings. fileName File name from which the document was opened for inserting into window caption. If this string is empty, the default document name is used. Returns A FormDocument containing this document.
bool	IsInside (double pointX, double pointY)
	Method which checks whether or not a point is inside the 2D region.
bool	IsInside (VectorD point)
	Method which checks whether or not a point is inside the 2D region.
void	MayBeNonzeroOutside (out bool maybeNonZeroLeft, out bool maybeNonZeroRight, out bool maybeNonZeroBottom, out bool maybeNonZeroTop)
	Method which determines whether or not the region can provide "inside" state outside of its boundary interval. This is not the case for extrapolation mode 'ConstantZero', of course.
	Region2D (bool boundariesAreInside, PhysicalProperty propertyOfCoordinatesX=PhysicalProperty.Length, PhysicalProperty propertyOfCoordinatesY=PhysicalProperty.Length)
	Constructor which gets the _boundariesAreInside flag. To be called from derived classes constructors.
	Region2D (Region2D region2bCopied)
	Copy constructor.
virtual void	UpdatePropertyOfCoordinates ()
	Method for handling update after change of the physical property of the coordinate.

Static Public Member Functions
static bool	operator!= (ElementaryRegion2D o1, ElementaryRegion2D o2)
	Unequals operator.
static bool	operator== (ElementaryRegion2D o1, ElementaryRegion2D o2)
	Equals operator.
Static Public Member Functions inherited from Region2D
static Region2D	InvertRegion (Region2D region2Invert)
	Creates a new region with inverted in / out regions compared to this.
static Region2D	Load (string fileName)
	Loads the specified file name. Works independently from whether the document has been saved without view settings (as prior to VL 6.0) or with view settings.
static bool	operator!= (Region2D o1, Region2D o2)
	Unequals operator.
static bool	operator== (Region2D o1, Region2D o2)
	Equals operator.

Additional Inherited Members
Static Public Attributes inherited from Region2D
const string	DefaultDocumentName
	The default document name (= type description) for an Order Collection.
static readonly string	FileDialogFilterString
	The filter string used in "Open File" dialogs.
const string	FileExtensionString
	The file extension for an Order Collection.
Properties inherited from Region2D
RectanglePhysical	AxisAlignedBoundingBox [get]
	Gets the bounding box for the 2D region. Its sides are parallel to the x- and y-axis resp.
bool	BoundariesAreInside [get, set]
	Gets or sets whether or not the boundaries of the region belong to the inner region.
string	CommentOfCoordinates_X [get, set]
	Gets and sets the comment for the x-coordinates.
string	CommentOfCoordinates_Y [get, set]
	Gets and sets the comment for the y-coordinates.
ExtrapolationInfo	ExtrapolationHandling [get, set]
	The extrapolation mode for this region. See ITN.064 for more information on the mode 'border continuation'.
bool	IsOneD [get]
	Gets whether this IRegion1D2D is 1D or 2D.
string	Name [get, set]
	The name which can be given to the region by the user.
PhysicalProperty	PropertyOfCoordinatesX [get, set]
	Physical property of the x-coordinates of the region.
PhysicalProperty	PropertyOfCoordinatesY [get, set]
	Physical property of the y-coordinates of the region.
Region2DType	RegionType [get]
	Gets the type of the region.
SamplingParameters	SamplingForUsageWithComplexFields [get, set]
	Sampling parameters which will be used for a coordinate rescaling in case of using the region with a complex field.
Properties inherited from IDocument
VirtualLabSession	Session [get, set]
	every documents need to be handled in a session ==> default is the VirtualLab Mainsession
NodeVLExplorer	TreeStructure [get]
	every document should have a node (maybe with subnodes) in the VirtualLab Explorer
DocumentType	TypeOfDocument [get]
	Gets an enum entry specifying the type of the document.

Detailed Description

This class is subject to change. Programs using this class may require changes with a new version of VirtualLab.
Base class for all Region2D derived classes which are not composed.

Constructor & Destructor Documentation

ElementaryRegion2D() [1/2]

ElementaryRegion2D	(	bool	boundariesAreInside,
		PhysicalProperty	propertyOfCoordinatesX = PhysicalProperty::Length,
		PhysicalProperty	propertyOfCoordinatesY = PhysicalProperty::Length )

Constructor which gets the _boundariesAreInside flag. To be called from derived classes constructors.

Parameters

boundariesAreInside	If true, values lying exactly on the boundaries are considered as being 'inside' the region.
propertyOfCoordinatesX	Physical property of the x-coordinate.
propertyOfCoordinatesY	Physical property of the y-coordinate.

ElementaryRegion2D() [2/2]

ElementaryRegion2D

(

ElementaryRegion2D

region2bCopied

)

Copy constructor.

Parameters

region2bCopied

The region to be copied.

Member Function Documentation

CalculateDistanceOfPointToRegionBorder()

double CalculateDistanceOfPointToRegionBorder ( VectorD point )

abstract

Calculates the distance of a point to the border of this region.

Parameters

point

Point to calculate the distance for.

Returns

The distance of the given point to the border of this region

operator!=()

static bool operator!= ( ElementaryRegion2D o1, ElementaryRegion2D o2 )

static

Unequals operator.

Parameters

o1
o2

Returns

operator==()

static bool operator== ( ElementaryRegion2D o1, ElementaryRegion2D o2 )

static

Equals operator.

Parameters

o1
o2

Returns