SupportPlaneData Class — NXOpen Python API Reference 12.0.0 documentation

# SupportPlaneData Class

class `NXOpen.GeometricUtilities.``SupportPlaneData`

  Bases: `NXOpen.TaggedObject`, `NXOpen.GeometricUtilities.IComponentBuilder`

  Represents a `NXOpen.GeometricUtilities.SupportPlaneData`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ExistingPlane | Returns or sets the existing face or plane
SupportPlane | Returns or sets the support plane
SupportPlaneLockStatus | Returns or sets the support plane lock status
Tag | Returns the Tag for this object.
WorkView | Returns or sets the work view required when lock plane status is `NXOpen.GeometricUtilities.SupportPlaneDataLockPlaneStatus.AfterFirstConstraint`

# Methods

Method | Description
--- | ---
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

SupportPlaneDataLockPlaneStatus Enumeration | Represents support plane lock status for associative basic curves

# Property Detail

## ExistingPlane

`SupportPlaneData.``ExistingPlane`

  Returns or sets the existing face or plane

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

  Getter Method

  Signature `ExistingPlane`

  Returns: |
  Return type: | `NXOpen.DisplayableObject`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ExistingPlane`

  Parameters: | existingPlane (`NXOpen.DisplayableObject`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## SupportPlane

`SupportPlaneData.``SupportPlane`

  Returns or sets the support plane

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

  Getter Method

  Signature `SupportPlane`

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

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SupportPlane`

  Parameters: | supportPlane (`NXOpen.Plane`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## SupportPlaneLockStatus

`SupportPlaneData.``SupportPlaneLockStatus`

  Returns or sets the support plane lock status

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

  Getter Method

  Signature `SupportPlaneLockStatus`

  Returns: |
  Return type: | `NXOpen.GeometricUtilities.SupportPlaneDataLockPlaneStatus`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `SupportPlaneLockStatus`

  Parameters: | lockPlaneStatus (`NXOpen.GeometricUtilities.SupportPlaneDataLockPlaneStatus`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

## WorkView

`SupportPlaneData.``WorkView`

  Returns or sets the work view required when lock plane status is `NXOpen.GeometricUtilities.SupportPlaneDataLockPlaneStatus.AfterFirstConstraint`

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

  Getter Method

  Signature `WorkView`

  Returns: |
  Return type: | `NXOpen.View`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `WorkView`

  Parameters: | workView (`NXOpen.View`) –

  New in version NX5.0.0.

  License requirements: solid_modeling (“SOLIDS MODELING”) OR drafting (“DRAFTING”) OR cam_base (“CAM BASE”) OR insp_programming (“INSPECTION PROGRAMMING”)

# Method Detail

## Validate

`SupportPlaneData.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.