Class SmartFrame3D

Represents a 3D smart frame.

Inheritance

System.Object

SmartObject

SmartFrame3D

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, 6, 0, 0)]
public class SmartFrame3D : SmartObject

Remarks

This class is available since v7.6.

Constructors

SmartFrame3D(ElementId, Boolean)

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

Declaration

public SmartFrame3D(ElementId inElementId, bool inIsReversed)

Parameters

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

SmartFrame3D(ElementId, ItemLabel, Boolean)

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

Declaration

public SmartFrame3D(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 frame Z direction is to be reversed.

SmartFrame3D(Frame3D, Double, Double, Double, Double, Double, Double)

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

Declaration

public SmartFrame3D(Frame3D inGeometry, double inExtentXMin, double inExtentXMax, double inExtentYMin, double inExtentYMax, double inExtentZMin, double inExtentZMax)

Parameters

Type	Name	Description
Frame3D	inGeometry	Geometry.
System.Double	inExtentXMin	Minimum X coordinate of extent.
System.Double	inExtentXMax	Maximum X coordinate of extent.
System.Double	inExtentYMin	Minimum Y coordinate of extent.
System.Double	inExtentYMax	Maximum Y coordinate of extent.
System.Double	inExtentZMin	Minimum Z coordinate of extent.
System.Double	inExtentZMax	Maximum Z coordinate of extent.

SmartFrame3D(SmartFrame3D, SmartAxis3D, SmartReal)

Initializes a new instance of the SmartFrame3D class as a pivoted frame.

Declaration

public SmartFrame3D(SmartFrame3D inReferenceFrame, SmartAxis3D inRotationAxis, SmartReal inRotationAngle)

Parameters

Type	Name	Description
SmartFrame3D	inReferenceFrame	Reference frame.
SmartAxis3D	inRotationAxis	Rotation axis.
SmartReal	inRotationAngle	Rotation angle.

SmartFrame3D(SmartFrame3D, SmartDirection3D, SmartReal)

Initializes a new instance of the SmartFrame3D class as an offset frame.

Declaration

public SmartFrame3D(SmartFrame3D inReferenceFrame, SmartDirection3D inDirection, SmartReal inDistance)

Parameters

Type	Name	Description
SmartFrame3D	inReferenceFrame	Reference frame.
SmartDirection3D	inDirection	Direction.
SmartReal	inDistance	Offset distance.

SmartFrame3D(SmartFrame3DType, Nullable<Frame3D>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, Nullable<Double>, ElementId, ItemLabel, Boolean)

Initializes a new instance of the SmartFrame3D class.

Declaration

public SmartFrame3D(SmartFrame3DType inType, Frame3D? inGeometry, double? inExtentXMin, double? inExtentXMax, double? inExtentYMin, double? inExtentYMax, double? inExtentZMin, double? inExtentZMax, ElementId inElementId, ItemLabel inItemLabel, bool inIsReversed)

Parameters

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

SmartFrame3D(SmartPlane3D, SmartPlane3D, SmartPlane3D, SmartReal, SmartReal)

Initializes a new instance of the SmartFrame3D class as frame by three planes.

Declaration

public SmartFrame3D(SmartPlane3D inOXYPlane, SmartPlane3D inFirstPlane, SmartPlane3D inSecondPlane, SmartReal inFirstDistance, SmartReal inSecondDistance)

Parameters

Type	Name	Description
SmartPlane3D	inOXYPlane	Oxy plane.
SmartPlane3D	inFirstPlane	First plane.
SmartPlane3D	inSecondPlane	Sec�nd plane.
SmartReal	inFirstDistance	Distance to the first plane.
SmartReal	inSecondDistance	Distance to the second plane.

SmartFrame3D(SmartPlane3D, SmartPoint3D, SmartAxis3D, SmartDirection3D)

Initializes a new instance of the SmartFrame3D class as frame on a plane.

Declaration

public SmartFrame3D(SmartPlane3D inOXYPlane, SmartPoint3D inProjectedPoint, SmartAxis3D inIntersectionAxis, SmartDirection3D inXDirection)

Parameters

Type	Name	Description
SmartPlane3D	inOXYPlane	Oxy plane.
SmartPoint3D	inProjectedPoint	Projected Point
SmartAxis3D	inIntersectionAxis	Intersection axis.
SmartDirection3D	inXDirection	X Direction.

SmartFrame3D(SmartPoint3D, SmartDirection3D, Boolean, SmartDirection3D)

Initializes a new instance of the SmartFrame3D class using a point and two directions.

Declaration

public SmartFrame3D(SmartPoint3D inOriginPoint, SmartDirection3D inXDirection, bool inIsYDirection, SmartDirection3D inYOrZDirection)

Parameters

Type	Name	Description
SmartPoint3D	inOriginPoint	The origin point.
SmartDirection3D	inXDirection	The x direction.
System.Boolean	inIsYDirection	If set to true [in is y direction].
SmartDirection3D	inYOrZDirection	The y or z direction.

SmartFrame3D(SmartPoint3D, SmartPoint3D, SmartPoint3D)

Initializes a new instance of the SmartFrame3D class as frame by three points.

Declaration

public SmartFrame3D(SmartPoint3D inOrigin, SmartPoint3D inPointTowardsX, SmartPoint3D inPointTowardsY)

Parameters

Type	Name	Description
SmartPoint3D	inOrigin	Origin point.
SmartPoint3D	inPointTowardsX	Point towards X.
SmartPoint3D	inPointTowardsY	Point towards Y.

Fields

ElementId

Providing element identifier, or empty if none.

Declaration

public ElementId ElementId

Field Value

Type	Description
ElementId

ExtentXMax

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

Declaration

public double? ExtentXMax

Field Value

Type	Description
System.Nullable<System.Double>

ExtentXMin

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

Declaration

public double? ExtentXMin

Field Value

Type	Description
System.Nullable<System.Double>

ExtentYMax

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

Declaration

public double? ExtentYMax

Field Value

Type	Description
System.Nullable<System.Double>

ExtentYMin

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

Declaration

public double? ExtentYMin

Field Value

Type	Description
System.Nullable<System.Double>

ExtentZMax

Maximum Z frame coordinate of extent, or null if unknown.

Declaration

public double? ExtentZMax

Field Value

Type	Description
System.Nullable<System.Double>

ExtentZMin

Minimum Z frame coordinate of extent, or null if unknown.

Declaration

public double? ExtentZMin

Field Value

Type	Description
System.Nullable<System.Double>

Geometry

Geometry, or null if unknown.

Declaration

public Frame3D? Geometry

Field Value

Type	Description
System.Nullable<Frame3D>

IsReversed

Whether the provided frame Z 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

OXYZ

(O,+X,+Y,+Z) absolute frame.

Declaration

public static readonly SmartFrame3D OXYZ

Field Value

Type	Description
SmartFrame3D

Type

Type of smart frame.

Declaration

public SmartFrame3DType Type

Field Value

Type	Description
SmartFrame3DType