Class SmartDirection2D

Represents a 2D smart direction.

Inheritance

System.Object

SmartObject

SmartDirection2D

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

[AvailableSinceVersion(7, 7, 0, 0)]
public class SmartDirection2D : SmartObject

Remarks

This class is available since v7.7.

Constructors

SmartDirection2D(Direction2D, Point2D)

Initializes a new instance of the SmartDirection2D class of type Basic.

Declaration

public SmartDirection2D(Direction2D inGeometry, Point2D inHelpPoint)

Parameters

Type	Name	Description
Direction2D	inGeometry	Direction geometry.
Point2D	inHelpPoint	Help point.

SmartDirection2D(ElementId, Boolean)

Initializes a new instance of the SmartDirection2D class of type Element.

Declaration

public SmartDirection2D(ElementId inElementId, bool inIsReversed)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of providing element.
System.Boolean	inIsReversed	Provided direction is to be reversed.

SmartDirection2D(ElementId, ItemLabel, Boolean)

Initializes a new instance of the SmartDirection2D class of type Item.

Declaration

public SmartDirection2D(ElementId inElementId, ItemLabel inItemLabel, bool inIsReversed)

Parameters

Type	Name	Description
ElementId	inElementId	Identifier of providing element.
ItemLabel	inItemLabel	Label of providing element item.
System.Boolean	inIsReversed	Provided direction is to be reversed.

SmartDirection2D(SmartDirection2DType, Nullable<Direction2D>, Nullable<Point2D>, ElementId, ItemLabel, Boolean)

Initializes a new instance of the SmartDirection2D class.

Declaration

public SmartDirection2D(SmartDirection2DType inType, Direction2D? inGeometry, Point2D? inHelpPoint, ElementId inElementId, ItemLabel inItemLabel, bool inIsReversed)

Parameters

Type	Name	Description
SmartDirection2DType	inType	Type of smart direction.
System.Nullable<Direction2D>	inGeometry	Geometry, or null if unknown.
System.Nullable<Point2D>	inHelpPoint	Help point, or null if unknown.
ElementId	inElementId	Identifier of providing element, or Empty for none.
ItemLabel	inItemLabel	Label of providing element item, or Empty for none.
System.Boolean	inIsReversed	Provided direction is to be reversed.

Fields

DX

Positive X direction, i.e. (1,0).

Declaration

public static readonly SmartDirection2D DX

Field Value

Type	Description
SmartDirection2D

DY

Positive Y direction, i.e. (0,1).

Declaration

public static readonly SmartDirection2D DY

Field Value

Type	Description
SmartDirection2D

ElementId

Providing element identifier, or empty if none.

Declaration

public ElementId ElementId

Field Value

Type	Description
ElementId

Geometry

Direction geometry, or null if unknown.

Declaration

public Direction2D? Geometry

Field Value

Type	Description
System.Nullable<Direction2D>

HelpPoint

Help point, or null if unknown.

Declaration

public Point2D? HelpPoint

Field Value

Type	Description
System.Nullable<Point2D>

IsReversed

Whether the provided direction is to be reversed.

Declaration

public bool IsReversed

Field Value

Type	Description
System.Boolean

ItemLabel

Providing element item label, or empty if none.

Declaration

public ItemLabel ItemLabel

Field Value

Type	Description
ItemLabel

Type

Type of smart direction.

Declaration

public SmartDirection2DType Type

Field Value

Type	Description
SmartDirection2DType