Class NwcSectionPlane
- Namespace
- NwcIO.Model.Sectioning
- Assembly
- NwcIO.dll
A dynamic clipping / cutting section plane in a Navisworks viewpoint. Supports up to 6 simultaneous section planes conforming to Navisworks sectioning tools.
public sealed record NwcSectionPlane : IEquatable<NwcSectionPlane>Inheritance
Implements
Inherited Members
Constructors
NwcSectionPlane()
public NwcSectionPlane()NwcSectionPlane(int, Vector3d, double, bool, NwcSectionAlignment)
public NwcSectionPlane(int planeIndex, Vector3d normal, double distance, bool isEnabled = true, NwcSectionAlignment alignment = NwcSectionAlignment.Custom)Parameters
planeIndexintnormalVector3ddistancedoubleisEnabledboolalignmentNwcSectionAlignment
Properties
Alignment
Standard alignment of the section plane.
public NwcSectionAlignment Alignment { get; init; }Property Value
Distance
Distance parameter along the normal vector from the origin (plane equation: N . P - d = 0).
public double Distance { get; init; }Property Value
IsEnabled
Whether this section plane is currently active and clipping geometry.
public bool IsEnabled { get; init; }Property Value
Normal
Surface normal vector pointing towards the retained half-space volume.
public Vector3d Normal { get; init; }Property Value
PlaneIndex
Index of the section plane (typically 0 to 5 in Navisworks).
public int PlaneIndex { get; init; }Property Value
Methods
ContainsPoint(Vector3d, double)
Evaluates whether the given 3D point is on the visible (retained) side of this clipping plane.
public bool ContainsPoint(Vector3d point, double tolerance = 1E-07)Parameters
Returns
CreateBack(double, int, bool)
public static NwcSectionPlane CreateBack(double yDistance, int index = 3, bool enabled = true)Parameters
Returns
CreateBottom(double, int, bool)
public static NwcSectionPlane CreateBottom(double zElevation, int index = 1, bool enabled = true)Parameters
Returns
CreateCustom(Vector3d, double, int, bool)
public static NwcSectionPlane CreateCustom(Vector3d normal, double distance, int index = 0, bool enabled = true)Parameters
Returns
CreateFront(double, int, bool)
public static NwcSectionPlane CreateFront(double yDistance, int index = 2, bool enabled = true)Parameters
Returns
CreateLeft(double, int, bool)
public static NwcSectionPlane CreateLeft(double xDistance, int index = 4, bool enabled = true)Parameters
Returns
CreateRight(double, int, bool)
public static NwcSectionPlane CreateRight(double xDistance, int index = 5, bool enabled = true)Parameters
Returns
CreateTop(double, int, bool)
public static NwcSectionPlane CreateTop(double zElevation, int index = 0, bool enabled = true)Parameters
Returns
SignedDistanceTo(Vector3d)
Computes the signed perpendicular distance from the point to this clipping plane. Positive if on the retained side of the plane, negative if clipped.
public double SignedDistanceTo(Vector3d point)Parameters
pointVector3d