CSPlane |
This is a class used to identify axis lines in 2D or planes in 3D.
A plane or axis is specified by the axis that is perpendicular to this plane or axis, and by the logical value along the
perpendicular axis.
Inheritance HierarchyNamespace: Altaxo.Graph
Assembly: AltaxoBase (in AltaxoBase.dll) Version: 4.8.3572.0 (4.8.3572.0)
SyntaxC#
public sealed class CSPlaneID : IImmutable
The CSPlaneID type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CSPlaneID(Int32, Double) | Initializes a new instance of the CSPlaneID class using a logical value. |
| CSPlaneID(Int32, Int32) | Initializes a new instance of the CSPlaneID class using an integral logical value. |
Properties| Name | Description | |
|---|---|---|
  | Back | Gets the back 2D plane. |
| Back3D | Gets the back 3D plane. |
| Bottom | Gets the bottom 2D plane. |
| Bottom3D | Gets the bottom 3D plane. |
| Front | Gets the front 2D plane. |
| Front3D | Gets the front 3D plane. |
| InPlaneAxisNumber1 | Returns the axis number of the first axis that lies on the plane. |
| InPlaneAxisNumber2 | Returns the axis number of the second axis that lies on the plane. |
| Left | Gets the left 2D plane. |
| Left3D | Gets the left 3D plane. |
| LogicalValue | The logical value of the isoline. It can be set only in the constructor, or if the UsePhysicalValue property is true. |
| PerpendicularAxisNumber | Number of axis: 0==X-Axis, 1==Y-Axis, 2==Z-Axis |
| PhysicalValue | The physical value of this axis. |
| Right | Gets the right 2D plane. |
| Right3D | Gets the right 3D plane. |
| Top | Gets the top 2D plane. |
| Top3D | Gets the top 3D plane. |
| UsePhysicalValue | True when the isoline of this axis is determined by a physical value together with the corresponding axis scale |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Overrides ObjectEquals(Object)) |
| FromPhysicalValue | Creates a plane identifier from a physical value. |
| FromPhysicalVariant | Creates a plane identifier from a physical variant value. |
| GetHashCode | Serves as the default hash function. (Overrides ObjectGetHashCode) |
| GetPlaneParallelToAxis2D | Gets the plane parallel to the specified 2D axis. |
| GetPlanesParallelToAxis3D | Gets the two planes parallel to the provided axis that are oriented to the main coordinate system axes. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WithLogicalValue | Returns a copy of this identifier with an updated logical value. |
Operators| Name | Description | |
|---|---|---|
 | Equality(CSPlaneID, CSPlaneID) | Determines whether two plane identifiers are equal. |
| (CSPlaneID to CSLineID) | Converts a 2D plane identifier to the corresponding line identifier. |
| Inequality(CSPlaneID, CSPlaneID) | Determines whether two plane identifiers are not equal. |
Remarks
The axis numbering is intended for the coordinate system. For cartesic coordinate systems
in 2D this means 0==X-Axis (normally horizontal), and 1==Y-Axis (vertical).
For 3D this means 0==X-Axis (horizontal), 1==Y-Axis (vertical, and 2==Z-Axis (points in the screen).
See Also