pluginbase.Helpers.Geometry.Segment Struct Reference

A line segment More...

Public Member Functions
	Segment (Vector3d start, Vector3d end)
	Initializes a new instance of the pluginbase.Helpers.Geometry.Segment struct. More...
	Segment (Vector3d start, Vector3d direction, double length)
	Initializes a new instance of the pluginbase.Helpers.Geometry.Segment struct. More...
	Segment (Ray ray, double length)
	Create a segment from a ray and a length More...
override string	ToString ()
	Creates a human-readable string representing the line segment More...

Public Attributes
Vector3d	Start
	The start coordinate of the line segment More...
Vector3d	End
	The end coordinate of the line segment More...

Properties
double	Length [get]
	Gets the length of the line segment More...
double	LengthFast [get]
	Gets the length of a line segment, computing fastly More...
Vector3d	Difference [get]
	Get the vector or a line direction More...
Vector3d	Direction [get]
	Get the normalized line direction Returns zero if the start and end are equal More...

Detailed Description

A line segment

Constructor & Destructor Documentation

Segment() [1/3]

pluginbase.Helpers.Geometry.Segment.Segment	(	Vector3d	start,
		Vector3d	end
	)

Initializes a new instance of the pluginbase.Helpers.Geometry.Segment struct.

Parameters

start	Start.
end	End.

        {
            Start = start;
            End = end;
        }

Segment() [2/3]

pluginbase.Helpers.Geometry.Segment.Segment	(	Vector3d	start,
		Vector3d	direction,
		double	length
	)

Initializes a new instance of the pluginbase.Helpers.Geometry.Segment struct.

Parameters

start	Start.
direction	Direction.
length	Length.

        {
            Start = start;
            End = start + direction * length;
        }

Segment() [3/3]

pluginbase.Helpers.Geometry.Segment.Segment	(	Ray	ray,
		double	length
	)

Create a segment from a ray and a length

Parameters

ray	Ray.
length	Length.

            :this(ray.Point, ray.Direction, length)
        { }

Member Function Documentation

ToString()

override string pluginbase.Helpers.Geometry.Segment.ToString

(

)

Creates a human-readable string representing the line segment

Returns

A System.String that represents the current pluginbase.Helpers.Geometry.Segment.

        {
            return string.Format("[Segment: {0} -> {1}]", Start, End);
        }

Member Data Documentation

End

Vector3d pluginbase.Helpers.Geometry.Segment.End

The end coordinate of the line segment

Start

Vector3d pluginbase.Helpers.Geometry.Segment.Start

The start coordinate of the line segment

Property Documentation

Difference

Vector3d pluginbase.Helpers.Geometry.Segment.Difference

get

Get the vector or a line direction

The diff vector.

Direction

Vector3d pluginbase.Helpers.Geometry.Segment.Direction

get

Get the normalized line direction Returns zero if the start and end are equal

The direction.

Length

double pluginbase.Helpers.Geometry.Segment.Length

get

Gets the length of the line segment

The length.

LengthFast

double pluginbase.Helpers.Geometry.Segment.LengthFast

get

Gets the length of a line segment, computing fastly

The length of the fast.

---

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

• pluginbase/Helpers/Geometry/Segment.cs