GeometricProperties Class — NXOpen Python API Reference 12.0.0 documentation

# GeometricProperties Class

class `NXOpen.GeometricAnalysis.``GeometricProperties`

  Bases: `NXOpen.Builder`

  Represents the Geometric Properties class.

  This class can be used to find local geometric properties of faces, edges, curves, CAE faces, and CAE edges/curves at a given point.

  To create a new instance of this class, use `NXOpen.GeometricAnalysis.AnalysisManager.CreateGeometricPropertiesObject()`

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ObjectsForAnalysis | Returns the Objects for analysis
OutputMethod | Returns or sets the output method
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCaeCurveProperties | Returns CAE curve local properties at the given point
GetCaeFaceProperties | Returns CAE face local properties at the given point
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetEdgeProperties | Returns edge/curve local properties at the given point
GetFaceProperties | Returns face local properties at the given point
GetObject | Returns the object currently being edited by this builder.
ListProperties | Displays the local properties of the specified object at the given point in the listing window
Reset | Clears all markers showing the local geometric properties in the graphics window
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

GeometricPropertiesEntity Enumeration | Type of input entity for geometric properties.
GeometricPropertiesOutputType Enumeration | Represents how to output geometric properties.
GeometricPropertiesStatus Enumeration | Status of computing geometric properties.

# Structs

GeometricPropertiesCaeCurve_Struct Struct | CAE Edge/Curve Geometric Properties
GeometricPropertiesCaeFace_Struct Struct | CAE Face Geometric Properties
GeometricPropertiesEdge_Struct Struct | Edge/Curve Geometric Properties
GeometricPropertiesFace_Struct Struct | Face Geometric Properties

# Property Detail

## ObjectsForAnalysis

`GeometricProperties.``ObjectsForAnalysis`

  Returns the Objects for analysis

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

  Getter Method

  Signature `ObjectsForAnalysis`

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

  New in version NX5.0.0.

  License requirements: None.

## OutputMethod

`GeometricProperties.``OutputMethod`

  Returns or sets the output method

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

  Getter Method

  Signature `OutputMethod`

  Returns: |
  Return type: | `NXOpen.GeometricAnalysis.GeometricPropertiesOutputType`

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `OutputMethod`

  Parameters: | outputMethod (`NXOpen.GeometricAnalysis.GeometricPropertiesOutputType`) –

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## GetCaeCurveProperties

`GeometricProperties.``GetCaeCurveProperties`

  Returns CAE curve local properties at the given point

  Signature `GetCaeCurveProperties(entityTag, absPoint)`

  Parameters:

  - entityTag (`NXOpen.NXObject`) – NXObject to obtain the properties for
  - absPoint (`NXOpen.Point3d`) – Absolute point co-ordinates of the reference point to compute the properties

  Returns: | a tuple
  Return type: | A tuple consisting of (status, caeCurve). status is a `NXOpen.GeometricAnalysis.GeometricPropertiesStatus`. Return status caeCurve is a `NXOpen.GeometricAnalysis.GeometricPropertiesCaeCurve_Struct`. CAE Edge/Curve Properties

  New in version NX5.0.0.

  License requirements: None.

## GetCaeFaceProperties

`GeometricProperties.``GetCaeFaceProperties`

  Returns CAE face local properties at the given point

  Signature `GetCaeFaceProperties(entityTag, absPoint)`

  Parameters:

  - entityTag (`NXOpen.NXObject`) – NXObject to obtain the properties for
  - absPoint (`NXOpen.Point3d`) – Absolute point co-ordinates of the reference point to compute the properties

  Returns: | a tuple
  Return type: | A tuple consisting of (status, caeFace). status is a `NXOpen.GeometricAnalysis.GeometricPropertiesStatus`. Return status caeFace is a `NXOpen.GeometricAnalysis.GeometricPropertiesCaeFace_Struct`. CAE Face Properties

  New in version NX5.0.0.

  License requirements: None.

## GetEdgeProperties

`GeometricProperties.``GetEdgeProperties`

  Returns edge/curve local properties at the given point

  Signature `GetEdgeProperties(entityTag, absPoint)`

  Parameters:

  - entityTag (`NXOpen.NXObject`) – NXObject to obtain the properties for
  - absPoint (`NXOpen.Point3d`) – Absolute point co-ordinates of the reference point to compute the properties

  Returns: | a tuple
  Return type: | A tuple consisting of (status, edge). status is a `NXOpen.GeometricAnalysis.GeometricPropertiesStatus`. Return status edge is a `NXOpen.GeometricAnalysis.GeometricPropertiesEdge_Struct`. Edge/Curve Properties

  New in version NX5.0.0.

  License requirements: None.

## GetFaceProperties

`GeometricProperties.``GetFaceProperties`

  Returns face local properties at the given point

  Signature `GetFaceProperties(entityTag, absPoint)`

  Parameters:

  - entityTag (`NXOpen.NXObject`) – NXObject to obtain the properties for
  - absPoint (`NXOpen.Point3d`) – Absolute point co-ordinates of the reference point to compute the properties

  Returns: | a tuple
  Return type: | A tuple consisting of (status, face). status is a `NXOpen.GeometricAnalysis.GeometricPropertiesStatus`. Return status face is a `NXOpen.GeometricAnalysis.GeometricPropertiesFace_Struct`. Face Properties

  New in version NX5.0.0.

  License requirements: None.

## ListProperties

`GeometricProperties.``ListProperties`

  Overloaded method ListProperties

  - `ListProperties(entityTag, absPoint)`
  - `ListProperties(absPoint)`

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

  Displays the local properties of the specified object at the given point in the listing window

  Signature `ListProperties(entityTag, absPoint)`

  Parameters:

  - entityTag (`NXOpen.NXObject`) – NXObject to obtain the properties for
  - absPoint (`NXOpen.Point3d`) – Absolute point co-ordinates of the reference point to compute the properties

  Returns: | Return status
  Return type: | `NXOpen.GeometricAnalysis.GeometricPropertiesStatus`

  New in version NX5.0.0.

  License requirements: None.

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

  Displays the local properties of `ObjectsForAnalysis()` at the given point in the listing window.

  Signature `ListProperties(absPoint)`

  Parameters: | absPoint (`NXOpen.Point3d`) – Absolute point co-ordinates of the reference point to compute the properties
  Returns: | Return status
  Return type: | `NXOpen.GeometricAnalysis.GeometricPropertiesStatus`

  New in version NX5.0.0.

  License requirements: None.

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

## Reset

`GeometricProperties.``Reset`

  Clears all markers showing the local geometric properties in the graphics window

  Signature `Reset()`

  New in version NX5.0.0.

  License requirements: None.

## Validate

`GeometricProperties.``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.