Class SmartPlane3D

Represents a 3D smart plane.

Inheritance

Object

SmartObject

SmartPlane3D

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: TopSolid.Kernel.Automating

Assembly: cs.temp.dll.dll

Syntax

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

Remarks

This class is available since v7.6.

Constructors

SmartPlane3D(ElementId, Boolean)

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

Declaration

public SmartPlane3D(ElementId inElementId, bool inIsReversed)

Parameters

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

SmartPlane3D(ElementId, ItemLabel, Boolean)

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

Declaration

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

Parameters

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

SmartPlane3D(Plane3D, Double, Double, Double, Double)

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

Declaration

public SmartPlane3D(Plane3D inGeometry, double inExtentXMin, double inExtentXMax, double inExtentYMin, double inExtentYMax)

Parameters

Type	Name	Description
Plane3D	inGeometry	Geometry.
Double	inExtentXMin	Minimum X coordinate of extent.
Double	inExtentXMax	Maximum X coordinate of extent.
Double	inExtentYMin	Minimum Y coordinate of extent.
Double	inExtentYMax	Maximum Y coordinate of extent.

SmartPlane3D(SmartPlane3DType, Nullable<Plane3D>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, ElementId, ItemLabel, Boolean)

Initializes a new instance of the SmartPlane3D class.

Declaration

public SmartPlane3D(SmartPlane3DType inType, Plane3D? inGeometry, double? inExtentXMin, double? inExtentXMax, double? inExtentYMin, double? inExtentYMax, ElementId inElementId, ItemLabel inItemLabel, bool inIsReversed)

Parameters

Type	Name	Description
SmartPlane3DType	inType	Type of smart plane.
Nullable<Plane3D>	inGeometry	Geometry, or null if unknown.
Nullable<Double>	inExtentXMin	Minimum X coordinate of extent, or null if unknown.
Nullable<Double>	inExtentXMax	Maximum X coordinate of extent, or null if unknown.
Nullable<Double>	inExtentYMin	Minimum Y coordinate of extent, or null if unknown.
Nullable<Double>	inExtentYMax	Maximum Y coordinate of extent, 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.
Boolean	inIsReversed	Provided plane Z direction is to be reversed.

Fields

ElementId

Providing element identifier, or empty if none.

Declaration

public ElementId ElementId

Field Value

Type	Description
ElementId

ExtentXMax

Maximum X plane coordinate of extent, or null if unknown.

Declaration

public double? ExtentXMax

Field Value

Type	Description
Nullable<Double>

ExtentXMin

Minimum X plane coordinate of extent, or null if unknown.

Declaration

public double? ExtentXMin

Field Value

Type	Description
Nullable<Double>

ExtentYMax

Maximum Y plane coordinate of extent, or null if unknown.

Declaration

public double? ExtentYMax

Field Value

Type	Description
Nullable<Double>

ExtentYMin

Minimum Y plane coordinate of extent, or null if unknown.

Declaration

public double? ExtentYMin

Field Value

Type	Description
Nullable<Double>

Geometry

Geometry, or null if unknown.

Declaration

public Plane3D? Geometry

Field Value

Type	Description
Nullable<Plane3D>

IsReversed

Whether the provided plane Z direction is to be reversed.

Declaration

public bool IsReversed

Field Value

Type	Description
Boolean

ItemLabel

Providing element item label, or empty if none.

Declaration

public ItemLabel ItemLabel

Field Value

Type	Description
ItemLabel

OXY

(O,+X,+Y) absolute plane.

Declaration

public static readonly SmartPlane3D OXY

Field Value

Type	Description
SmartPlane3D

OXZ

(O,+X,+Z) absolute plane.

Declaration

public static readonly SmartPlane3D OXZ

Field Value

Type	Description
SmartPlane3D

OYX

(O,+Y,+X) absolute plane.

Declaration

public static readonly SmartPlane3D OYX

Field Value

Type	Description
SmartPlane3D

OYZ

(O,+Y,+Z) absolute plane.

Declaration

public static readonly SmartPlane3D OYZ

Field Value

Type	Description
SmartPlane3D

OZX

(O,+Z,+X) absolute plane.

Declaration

public static readonly SmartPlane3D OZX

Field Value

Type	Description
SmartPlane3D

OZY

(O,+Z,+Y) absolute plane.

Declaration

public static readonly SmartPlane3D OZY

Field Value

Type	Description
SmartPlane3D

Type

Type of plane.

Declaration

public SmartPlane3DType Type

Field Value

Type	Description
SmartPlane3DType