oevislib_net  0.14.3.0
Loading...
Searching...
No Matches

Functions

 oevislib_net.ShapeRegion.ShapeRegion ()
 Creates a new empty ShapeRegion tagged as 'Region'.
 oevislib_net.ShapeRegion.ShapeRegion (ShapeRegionType inTag)
 Creates a new ShapeRegion object using the provided tag.
 oevislib_net.ShapeRegion.ShapeRegion (Region inRegion)
 Creates a new ShapeRegion using the provided Region.
 oevislib_net.ShapeRegion.ShapeRegion (Rectangle2D inRectangle)
 Creates a new ShapeRegion using the provided rectangle.
 oevislib_net.ShapeRegion.ShapeRegion (Circle2D inCircle)
 Constructs a new ShapeRegion object given a Circle2D.
 oevislib_net.ShapeRegion.ShapeRegion (Path inPolygon)
 Constructs a new Shape Region object given a Path.
 oevislib_net.ShapeRegion.ShapeRegion (Ring2D inRing)
 Constructs a new ShapeRegion object given a Ring2D.
 oevislib_net.ShapeRegion.ShapeRegion (Ellipse2D inEllipse)
 Constructs a new ShapeRegion object given an Ellipse2D.
bool oevislib_net.ShapeRegion.IsEmpty ()
 Returns true if the ShapeRegion contains at least one point, false otherwise.
ShapeRegionType oevislib_net.ShapeRegion.GetTag ()
 Returns the ShapeRegion tag.
Region oevislib_net.ShapeRegion.GetRegion ()
 Returns the Region contained in the ShapeRegion object.
Rectangle2D oevislib_net.ShapeRegion.GetRectangle ()
 Returns the Rectangle2D contained in the ShapeRegion object.
Circle2D oevislib_net.ShapeRegion.GetCircle ()
 Returns the Circle2D contained in the ShapeRegion object.
Path oevislib_net.ShapeRegion.GetPolygon ()
 Returns the Path contained in the ShapeRegion object.
Ring2D oevislib_net.ShapeRegion.GetRing ()
 Returns the Ring2D contained in the ShapeRegion object.
Ellipse2D oevislib_net.ShapeRegion.GetEllipse ()
 Returns the Ellipse2D contained in the ShapeRegion object.
void oevislib_net.ShapeRegion.SetTag (ShapeRegionType inTag)
 Sets the tag of the ShapeRegion object.
void oevislib_net.ShapeRegion.SetRegion (Region inRegion)
 Sets the Region of the ShapeRegion object.
void oevislib_net.ShapeRegion.SetRectangle (Rectangle2D inRectangle)
 Sets the Rectangle2D of the ShapeRegion object.
void oevislib_net.ShapeRegion.SetCircle (Circle2D inCircle)
 Sets the Circle2D of the ShapeRegion object.
void oevislib_net.ShapeRegion.SetPolygon (Path inPolygon)
 Sets the Path of the ShapeRegion object.
void oevislib_net.ShapeRegion.SetRing (Ring2D inRing)
 Sets the Ring2D of the ShapeRegion object.
void oevislib_net.ShapeRegion.SetEllipse (Ellipse2D inEllipse)
 Sets the Ellipse2D of the ShapeRegion object.
ByteBuffer oevislib_net.ShapeRegion.Serialize ()
 Serializes the ShapeRegion object.
static ShapeRegion oevislib_net.ShapeRegion.Deserialize (ByteBuffer inBuffer)
 De-serialize a ShapeRegion buffer.
Region oevislib_net.ShapeRegion.ConvertToRegion (Optional< Size > inFrame=null, Optional< UCS2D > inShapeRegionAlignment=null)
 Convert the shape region into a Region object.

Detailed Description

Function Documentation

◆ ConvertToRegion()

Region oevislib_net.ShapeRegion.ConvertToRegion ( Optional< Size > inFrame = null,
Optional< UCS2D > inShapeRegionAlignment = null )
inline

Convert the shape region into a Region object.

Parameters
inFrameInput frame. If Null, the frame dimension is automatically assigned to be the smallest possible size that contains every point.
inShapeRegionAlignmentCoordinate system of the provided shape region.
Returns
The computed region.

◆ Deserialize()

ShapeRegion oevislib_net.ShapeRegion.Deserialize ( ByteBuffer inBuffer)
inlinestatic

De-serialize a ShapeRegion buffer.

Parameters
inBufferBuffer containing the object.
Returns
Deserialized object.

◆ GetCircle()

Circle2D oevislib_net.ShapeRegion.GetCircle ( )
inline

Returns the Circle2D contained in the ShapeRegion object.

Returns
The associated circle.

◆ GetEllipse()

Ellipse2D oevislib_net.ShapeRegion.GetEllipse ( )
inline

Returns the Ellipse2D contained in the ShapeRegion object.

Returns
The associated ellipse.

◆ GetPolygon()

Path oevislib_net.ShapeRegion.GetPolygon ( )
inline

Returns the Path contained in the ShapeRegion object.

Returns
The associated path.

◆ GetRectangle()

Rectangle2D oevislib_net.ShapeRegion.GetRectangle ( )
inline

Returns the Rectangle2D contained in the ShapeRegion object.

Returns
The Rectangle2D contained in the ShapeRegion object.

◆ GetRegion()

Region oevislib_net.ShapeRegion.GetRegion ( )
inline

Returns the Region contained in the ShapeRegion object.

Returns
The Region contained in the ShapeRegion object.

◆ GetRing()

Ring2D oevislib_net.ShapeRegion.GetRing ( )
inline

Returns the Ring2D contained in the ShapeRegion object.

Returns
The associated ring.

◆ GetTag()

ShapeRegionType oevislib_net.ShapeRegion.GetTag ( )
inline

Returns the ShapeRegion tag.

Returns
The associated tag.

◆ IsEmpty()

bool oevislib_net.ShapeRegion.IsEmpty ( )
inline

Returns true if the ShapeRegion contains at least one point, false otherwise.

Returns
True if the ShapeRegion contains at least one point, false otherwise.

◆ Serialize()

ByteBuffer oevislib_net.ShapeRegion.Serialize ( )
inline

Serializes the ShapeRegion object.

Returns
Buffer where the object is stored.

◆ SetCircle()

void oevislib_net.ShapeRegion.SetCircle ( Circle2D inCircle)
inline

Sets the Circle2D of the ShapeRegion object.

Parameters
inCircleInput circle.

◆ SetEllipse()

void oevislib_net.ShapeRegion.SetEllipse ( Ellipse2D inEllipse)
inline

Sets the Ellipse2D of the ShapeRegion object.

Parameters
inEllipseInput ellipse.

◆ SetPolygon()

void oevislib_net.ShapeRegion.SetPolygon ( Path inPolygon)
inline

Sets the Path of the ShapeRegion object.

Parameters
inPolygonInput path.

◆ SetRectangle()

void oevislib_net.ShapeRegion.SetRectangle ( Rectangle2D inRectangle)
inline

Sets the Rectangle2D of the ShapeRegion object.

Parameters
inRectangleInput rectangle.

◆ SetRegion()

void oevislib_net.ShapeRegion.SetRegion ( Region inRegion)
inline

Sets the Region of the ShapeRegion object.

Parameters
inRegionInput region.

◆ SetRing()

void oevislib_net.ShapeRegion.SetRing ( Ring2D inRing)
inline

Sets the Ring2D of the ShapeRegion object.

Parameters
inRingInput ring.

◆ SetTag()

void oevislib_net.ShapeRegion.SetTag ( ShapeRegionType inTag)
inline

Sets the tag of the ShapeRegion object.

Parameters
inTagInput tag.

◆ ShapeRegion() [1/8]

oevislib_net.ShapeRegion.ShapeRegion ( )
inline

Creates a new empty ShapeRegion tagged as 'Region'.

◆ ShapeRegion() [2/8]

oevislib_net.ShapeRegion.ShapeRegion ( Circle2D inCircle)
inline

Constructs a new ShapeRegion object given a Circle2D.

Parameters
inCircleCircle.

◆ ShapeRegion() [3/8]

oevislib_net.ShapeRegion.ShapeRegion ( Ellipse2D inEllipse)
inline

Constructs a new ShapeRegion object given an Ellipse2D.

Parameters
inEllipseEllipse.

◆ ShapeRegion() [4/8]

oevislib_net.ShapeRegion.ShapeRegion ( Path inPolygon)
inline

Constructs a new Shape Region object given a Path.

Parameters
inPolygonPolygon.

◆ ShapeRegion() [5/8]

oevislib_net.ShapeRegion.ShapeRegion ( Rectangle2D inRectangle)
inline

Creates a new ShapeRegion using the provided rectangle.

Parameters
inRectangleInput rectangle.

◆ ShapeRegion() [6/8]

oevislib_net.ShapeRegion.ShapeRegion ( Region inRegion)
inline

Creates a new ShapeRegion using the provided Region.

Parameters
inRegionInput region.

◆ ShapeRegion() [7/8]

oevislib_net.ShapeRegion.ShapeRegion ( Ring2D inRing)
inline

Constructs a new ShapeRegion object given a Ring2D.

Parameters
inRingRing.

◆ ShapeRegion() [8/8]

oevislib_net.ShapeRegion.ShapeRegion ( ShapeRegionType inTag)
inline

Creates a new ShapeRegion object using the provided tag.

Parameters
inTagTag identifying the encapsulated object.