PlaneCollection Class — NXOpen Python API Reference 12.0.0 documentation

# PlaneCollection Class

class `NXOpen.``PlaneCollection`

  Bases: `object`

  Represents a collection of `NXOpen.Plane`.

  Iterating this collection only returns live uncondemned objects contained in the owning part of the collection. Note that `NXOpen.Plane` is a smart object and many smart objects are condemned as they only exist to support other objects and are not displayed. To obtain an instance of this class, refer to `NXOpen.BasePart`

  New in version NX4.0.0.

# Methods

Method | Description
--- | ---
CreateFixedPlane | Creates a `Plane` without parameters.
CreateFixedTypePlane | Creates a `Plane`, it is still a smart plane but has fixed plane type.
CreatePlane | Creates a `Plane` without parameters.

# Method Detail

## CreateFixedPlane

`PlaneCollection.``CreateFixedPlane`

  Overloaded method CreateFixedPlane

  - `CreateFixedPlane(origin, matrix)`
  - `CreateFixedPlane(origin, matrix, show)`

  `-------------------------------------`

  Creates a `Plane` without parameters.

  Signature `CreateFixedPlane(origin, matrix)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Plane Origin
  - matrix (`NXOpen.Matrix3x3`) – Plane Matrix

  Returns: | the plane
  Return type: | `NXOpen.Plane`

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

  Creates a `Plane` without parameters. Has an additional input flag to control if the plane is visible or not after creation.

  Signature `CreateFixedPlane(origin, matrix, show)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Plane Origin
  - matrix (`NXOpen.Matrix3x3`) – Plane Matrix
  - show (bool) – Control whether to show the plane object

  Returns: | the plane
  Return type: | `NXOpen.Plane`

  New in version NX11.0.0.

  License requirements: None.

  `-------------------------------------`

## CreateFixedTypePlane

`PlaneCollection.``CreateFixedTypePlane`

  Creates a `Plane`, it is still a smart plane but has fixed plane type.

  Signature `CreateFixedTypePlane(origin, matrix, updateOption)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Plane Origin
  - matrix (`NXOpen.Matrix3x3`) – Plane Matrix
  - updateOption (`NXOpen.SmartObjectUpdateOption`) – Smart Object update option

  Returns: | the plane
  Return type: | `NXOpen.Plane`

  New in version NX11.0.1.

  License requirements: None.

## CreatePlane

`PlaneCollection.``CreatePlane`

  Overloaded method CreatePlane

  - `CreatePlane(origin, normal, updateOption)`
  - `CreatePlane(datum)`
  - `CreatePlane(method, alternate, origin, normal, expression, flip, percent, geometry)`

  `-------------------------------------`

  Creates a `Plane` without parameters.

  Signature `CreatePlane(origin, normal, updateOption)`

  Parameters:

  - origin (`NXOpen.Point3d`) – Plane Origin
  - normal (`NXOpen.Vector3d`) – Plane normal
  - updateOption (`NXOpen.SmartObjectUpdateOption`) – Smart Object update option

  Returns: | the plane
  Return type: | `NXOpen.Plane`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Creates a `Plane` using a datum plane feature.

  Signature `CreatePlane(datum)`

  Parameters: | datum (`NXOpen.Features.Feature`) – Datum Feature
  Returns: | the plane
  Return type: | `NXOpen.Plane`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`

  Creates a `Plane` using a datum plane feature.

  Signature `CreatePlane(method, alternate, origin, normal, expression, flip, percent, geometry)`

  Parameters:

  - method (`NXOpen.PlaneTypesMethodType`) –
  - alternate (`NXOpen.PlaneTypesAlternateType`) –
  - origin (`NXOpen.Point3d`) – Plane Origin
  - normal (`NXOpen.Vector3d`) – Plane normal
  - expression (str) – offset value
  - flip (bool) – flip direction
  - percent (bool) – arclength or percent value
  - geometry (list of `NXOpen.NXObject`) –

  Returns: | the plane
  Return type: | `NXOpen.Plane`

  New in version NX4.0.0.

  License requirements: None.

  `-------------------------------------`