Class PositionedLine

Namespace

VirtualLabAPI.Core.Numerics

Assembly

VirtualLabAPI.dll

Class for objects that describe positioned lines in space.

public class PositionedLine

Inheritance

object

PositionedLine

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PositionedLine(Position, Vector3D)

Constructor that defines the line by parameters.

public PositionedLine(Position position, Vector3D direction)

Parameters

position Position

One point that lies on the line.

direction Vector3D

Direction vector of the line.

PositionedLine(PositionedLine)

Copy constructor.

public PositionedLine(PositionedLine line)

Parameters

line PositionedLine

Line to be copied.

Properties

Direction

Direction vector of the line.

public Vector3D Direction { get; set; }

Property Value

Vector3D

GetPositioningReference

Gets the coordinate system that serves as reference for this object.

public CartesianCoordinateSystem GetPositioningReference { get; }

Property Value

CartesianCoordinateSystem

IsDefinedAbsolutely

Are the line position and direction defined in absolute coordinates?

public bool IsDefinedAbsolutely { get; }

Property Value

bool

Position

One point that lies on the line.

public Position Position { get; set; }

Property Value

Position

PositioningReferenceKey

Gets the key of the reference coordinate system for this object.

public string PositioningReferenceKey { get; }

Property Value

string

PositioningReferenceProvider

Gets the object that provides the reference coordinate system for this object.

public IProvidesPositioningReferences PositioningReferenceProvider { get; }

Property Value

IProvidesPositioningReferences

Methods

SetPositioningReference(IProvidesPositioningReferences, string)

Method to set the PositioningReferenceProvider and the key for the coordinate system that serves as positioning reference.

public void SetPositioningReference(IProvidesPositioningReferences referenceProvider, string key)

Parameters

referenceProvider IProvidesPositioningReferences

Object which provides the coordinate system that serves as reference for this position.

key string

Key for the coordinate system (contained by PositioningReferenceProvider) which shall serve as reference for this position.