Functions
	oevislib_net.Path.Path ()
	Creates an empty Path.
	oevislib_net.Path.Path (bool inClosed)
	Creates an empty Path, specifying if it's closed or not.
	oevislib_net.Path.Path (int inSize, bool inClosed=false)
	Creates a new Path with the provided size.
	oevislib_net.Path.Path (Segment2D inSegment)
	Creates a new Path from a Segment2D (using its two points).
	oevislib_net.Path.Path (Array< Point2D > inPoints, bool inClosed)
	Creates a new Path from an array of points.
int	oevislib_net.Path.GetSize ()
	Returns the number of points contained in the path.
ByteBuffer	oevislib_net.Path.Serialize ()
	Serialize the Path object using flatbuffers.
static Path	oevislib_net.Path.Deserialize (ByteBuffer inBuffer)
	De-serialize a Path buffer.
void	oevislib_net.Path.Append (Point2D inPoint)
	Appends a point to the end of the path.
void	oevislib_net.Path.Append (Array< Point2D > inPoints)
	Appends an array of points to the end of the path.
void	oevislib_net.Path.Remove (int inIndex, bool inInverse)
	Removes a point from the path.
static Path	oevislib_net.Path.FromArc (Arc2D inArc, int inPointCount)
	Creates an open path starting from the provided arc object.
static Path	oevislib_net.Path.FromCircle (Circle2D inCircle, int inPointCount)
	Creates a closed path from the provided circle object.
static Path	oevislib_net.Path.FromEllipse (Ellipse2D inEllipse, int inPointCount)
	Creates a closed path from the provided ellipse object.
static Path	oevislib_net.Path.FromRectangle (Rectangle2D inRectangle)
	Creates a closed path using the four vertices of the provided rectangle.
static Path	oevislib_net.Path.FromSegment (Segment2D inSegment, int inPointCount)
	Creates an open path using the provided segment object.
bool	oevislib_net.Path.IsClosed ()
	Returns if the path is closed.
Point2D	oevislib_net.Path.GetPoint (int inIndex, bool inInverse)
	Returns a specific point from the Path.
Point2D	oevislib_net.Path.GetPoint (float inIndex)
	Returns the linear interpolation of two consecutive path points.
Array< Point2D >	oevislib_net.Path.GetData ()
	Returns the pointer to the first point of the path.
void	oevislib_net.Path.SetClosed (bool inClosed)
	Sets the path as open or closed based on the input.
void	oevislib_net.Path.SetPoint (Point2D inPoint, int inIndex, bool inInverse)
	Changes the value of the point at the provided index.
Point2D	oevislib_net.Path.GetPointAtDistance (float inDistance, bool inInverse)
	Returns a point at a certain distance from the path starting point.
Segment2D	oevislib_net.Path.GetSegment (int inIndex, bool inInverse)
	Returns the segment starting with the point at the provided index and ending with the following point on the path.
Path	oevislib_net.Path.ExtractSubpath (int inStart, int inPointCount)
	Extracts a new path starting from the provided point.
bool	oevislib_net.Path.IsEmpty ()
	Checks if the path is empty.
bool	oevislib_net.Path.IsPolygon ()
	Checks if the path can be considered a polygon.

Detailed Description

Function Documentation

◆ Append() [1/2]

void oevislib_net.Path.Append ( Array< Point2D > inPoints )

inline

Appends an array of points to the end of the path.

Parameters

inPoints Array of points to add.

◆ Append() [2/2]

void oevislib_net.Path.Append ( Point2D inPoint )

inline

Appends a point to the end of the path.

Parameters

inPoint Point to add.

◆ Deserialize()

Path oevislib_net.Path.Deserialize ( ByteBuffer inBuffer )

inlinestatic

De-serialize a Path buffer.

Parameters

inBuffer Buffer containing the object.

Returns: Deserialized object.

◆ ExtractSubpath()

Path oevislib_net.Path.ExtractSubpath	(	int	inStart,
		int	inPointCount )

inline

Extracts a new path starting from the provided point.

Parameters

inStart	Index of the new path starting point. Range: [0, +inf).
inPointCount	Number of points that will be extracted. Range: [1, +inf).

Returns: The extracted sub-path.

◆ FromArc()

Path oevislib_net.Path.FromArc	(	Arc2D	inArc,
		int	inPointCount )

inlinestatic

Creates an open path starting from the provided arc object.

Parameters

inArc	Input arc.
inPointCount	Number of path points. Range: [2, +inf).

Returns: Path object.

◆ FromCircle()

Path oevislib_net.Path.FromCircle	(	Circle2D	inCircle,
		int	inPointCount )

inlinestatic

Creates a closed path from the provided circle object.

Parameters

inCircle	Input circle.
inPointCount	Number of path points. Range: [2, +inf).

Returns: Path object.

◆ FromEllipse()

Path oevislib_net.Path.FromEllipse	(	Ellipse2D	inEllipse,
		int	inPointCount )

inlinestatic

Creates a closed path from the provided ellipse object.

Parameters

inEllipse	Input ellipse.
inPointCount	Number of path points. Range: [2, +inf).

Returns: Path object.

◆ FromRectangle()

Path oevislib_net.Path.FromRectangle ( Rectangle2D inRectangle )

inlinestatic

Creates a closed path using the four vertices of the provided rectangle.

Parameters

inRectangle Input rectangle.

Returns: Path object.

◆ FromSegment()

Path oevislib_net.Path.FromSegment	(	Segment2D	inSegment,
		int	inPointCount )

inlinestatic

Creates an open path using the provided segment object.

Parameters

inSegment	Input segment.
inPointCount	Number of path points. Range: [2, +inf).

Returns: Path object.

◆ GetData()

Array< Point2D > oevislib_net.Path.GetData ( )

inline

Returns the pointer to the first point of the path.

Returns: Pointer to the first point.

◆ GetPoint() [1/2]

Point2D oevislib_net.Path.GetPoint ( float inIndex )

inline

Returns the linear interpolation of two consecutive path points.

Parameters

inIndex Point index (floating-point).

Returns: Point.

◆ GetPoint() [2/2]

Point2D oevislib_net.Path.GetPoint	(	int	inIndex,
		bool	inInverse )

inline

Returns a specific point from the Path.

Parameters

inIndex	Point index. Range: [0, +inf).
inInverse	true if points order must be reversed when considering the index.

Returns: Point.

◆ GetPointAtDistance()

Point2D oevislib_net.Path.GetPointAtDistance	(	float	inDistance,
		bool	inInverse )

inline

Returns a point at a certain distance from the path starting point.

Parameters

inDistance	Distance from the path starting point. Range: [0, +inf).
inInverse	If true, the distance is measured from the endpoint instead.

Returns: Point.

◆ GetSegment()

Segment2D oevislib_net.Path.GetSegment	(	int	inIndex,
		bool	inInverse )

inline

Returns the segment starting with the point at the provided index and ending with the following point on the path.

Parameters

inIndex	Input index. Range: [0, +inf).
inInverse	If true, the index is counted from the path endpoint.

Returns: Segment.

◆ GetSize()

int oevislib_net.Path.GetSize ( )

inline

Returns the number of points contained in the path.

Returns: The computed size.

◆ IsClosed()

bool oevislib_net.Path.IsClosed ( )

inline

Returns if the path is closed.

Returns: true if the path is closed, false otherwise.

◆ IsEmpty()

bool oevislib_net.Path.IsEmpty ( )

inline

Checks if the path is empty.

Returns: true if the path does not contain points, false otherwise.

◆ IsPolygon()

bool oevislib_net.Path.IsPolygon ( )

inline

Checks if the path can be considered a polygon.

Returns: true if the path is closed and does not have self-intersections, false otherwise.

◆ Path() [1/5]

oevislib_net.Path.Path ( )

inline

Creates an empty Path.

◆ Path() [2/5]

oevislib_net.Path.Path	(	Array< Point2D >	inPoints,
		bool	inClosed )

inline

Creates a new Path from an array of points.

Parameters

inPoints	Array of points.
inClosed	true if the path is closed.

◆ Path() [3/5]

oevislib_net.Path.Path ( bool inClosed )

inline

Creates an empty Path, specifying if it's closed or not.

Parameters

inClosed true if the path is closed, false otherwise.

◆ Path() [4/5]

oevislib_net.Path.Path	(	int	inSize,
		bool	inClosed = false )

inline

Creates a new Path with the provided size.

Parameters

inSize	Length of the path. Range: [0, +inf).
inClosed	Whether the path is closed or not.

◆ Path() [5/5]

oevislib_net.Path.Path ( Segment2D inSegment )

inline

Creates a new Path from a Segment2D (using its two points).

Parameters

inSegment Segment.

◆ Remove()

void oevislib_net.Path.Remove	(	int	inIndex,
		bool	inInverse )

inline

Removes a point from the path.

Parameters

inIndex	Point index. Range: [0, +inf).
inInverse	true if points order must be reversed when considering the index.

◆ Serialize()

ByteBuffer oevislib_net.Path.Serialize ( )

inline

Serialize the Path object using flatbuffers.

Returns: Buffer where the object is stored.

◆ SetClosed()

void oevislib_net.Path.SetClosed ( bool inClosed )

inline

Sets the path as open or closed based on the input.

Parameters

inClosed true if the path has to be closed, false otherwise.

◆ SetPoint()

void oevislib_net.Path.SetPoint	(	Point2D	inPoint,
		int	inIndex,
		bool	inInverse )

inline

Changes the value of the point at the provided index.

Parameters

inPoint	Input point.
inIndex	Input index. Range: [0, +inf).
inInverse	Whether to consider index starting from the back of the path.

Functions

Detailed Description

Function Documentation

◆ Append() [1/2]

◆ Append() [2/2]

◆ Deserialize()

◆ ExtractSubpath()

◆ FromArc()

◆ FromCircle()

◆ FromEllipse()

◆ FromRectangle()

◆ FromSegment()

◆ GetData()

◆ GetPoint() [1/2]

◆ GetPoint() [2/2]

◆ GetPointAtDistance()

◆ GetSegment()

◆ GetSize()

◆ IsClosed()

◆ IsEmpty()

◆ IsPolygon()

◆ Path() [1/5]

◆ Path() [2/5]

◆ Path() [3/5]

◆ Path() [4/5]

◆ Path() [5/5]

◆ Remove()

◆ Serialize()

◆ SetClosed()

◆ SetPoint()