PointCloudBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# PointCloudBuilder Class

class `NXOpen.Display.``PointCloudBuilder`

  Bases: `NXOpen.Builder`

  Represents a `Display.PointCloudBuilder`.

  :py:class:`NXOpen.Display.PointCloud`is a cloud object based on an imported point data files file (e.g. a POD file from Bentley). The point data (list of coordinates) itself won’t be stored within NX part file but an object (“Reference Point Cloud”) is created which references to the point data file and stores several meta data like clipping areas, display and current location. When loaded the point cloud will be visible as defined in the object parameters. Access to the point cloud like display, measurement, blanking/showing, sectioning, POD file loading will requires license checkout of the new basic point cloud license. For deleting a Reference Point Cloud object the license is not required.

  To create a new instance of this class, use `NXOpen.Display.PointCloudCollection.CreatePointCloudBuilder()`

  Default values.

  Property | Value
  --- | ---
  LoadPointDataWithPart | 1
  PointBrightnessMode | Uniform
  PointColorMode | Individual
  PointDensity | 100.0
  PointSize | 1

  New in version NX11.0.0.

# Properties

Property | Description
--- | ---
ClippingBoxesList | Returns the list of `NXOpen.Display.PointCloudClippingBoxesListItemBuilder` defining the clipping boxes parameters.
LoadPointDataWithPart | Returns or sets the indication if the point cloud data will be loaded with part load.
PointBrightnessMode | Returns or sets the point brightness display mode
PointColorMode | Returns or sets the point color display mode
PointDataFile | Returns or sets the point cloud data file.
PointDensity | Returns or sets the point density
PointSize | Returns or sets the point size
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
CreateClippingBoxesListItemBuilder | Creates a `Display.PointCloudClippingBoxesListItemBuilder`.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
LoadPointData | Loads the selected point cloud data now.
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

PointCloudBuilderBrightnessModes Enumeration | Specifies point cloud brightness display mode choice.
PointCloudBuilderColorModes Enumeration | Specifies point cloud color display mode choice.

# Property Detail

## ClippingBoxesList

`PointCloudBuilder.``ClippingBoxesList`

  Returns the list of `NXOpen.Display.PointCloudClippingBoxesListItemBuilder` defining the clipping boxes parameters.

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

  Getter Method

  Signature `ClippingBoxesList`

  Returns: |
  Return type: | `NXOpen.Display.PointCloudClippingBoxesListItemBuilderList`

  New in version NX11.0.0.

  License requirements: None.

## LoadPointDataWithPart

`PointCloudBuilder.``LoadPointDataWithPart`

  Returns or sets the indication if the point cloud data will be loaded with part load.

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

  Getter Method

  Signature `LoadPointDataWithPart`

  Returns: |
  Return type: | bool

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `LoadPointDataWithPart`

  Parameters: | loadPointDataWithPart (bool) –

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## PointBrightnessMode

`PointCloudBuilder.``PointBrightnessMode`

  Returns or sets the point brightness display mode

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

  Getter Method

  Signature `PointBrightnessMode`

  Returns: |
  Return type: | `NXOpen.Display.PointCloudBuilderBrightnessModes`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointBrightnessMode`

  Parameters: | pointBrightnessMode (`NXOpen.Display.PointCloudBuilderBrightnessModes`) –

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## PointColorMode

`PointCloudBuilder.``PointColorMode`

  Returns or sets the point color display mode

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

  Getter Method

  Signature `PointColorMode`

  Returns: |
  Return type: | `NXOpen.Display.PointCloudBuilderColorModes`

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointColorMode`

  Parameters: | pointColorMode (`NXOpen.Display.PointCloudBuilderColorModes`) –

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## PointDataFile

`PointCloudBuilder.``PointDataFile`

  Returns or sets the point cloud data file.

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

  Getter Method

  Signature `PointDataFile`

  Returns: |
  Return type: | str

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointDataFile`

  Parameters: | filename (str) –

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## PointDensity

`PointCloudBuilder.``PointDensity`

  Returns or sets the point density

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

  Getter Method

  Signature `PointDensity`

  Returns: |
  Return type: | float

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointDensity`

  Parameters: | pointDensity (float) –

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## PointSize

`PointCloudBuilder.``PointSize`

  Returns or sets the point size

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

  Getter Method

  Signature `PointSize`

  Returns: |
  Return type: | int

  New in version NX11.0.0.

  License requirements: None.

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

  Setter Method

  Signature `PointSize`

  Parameters: | pointSize (int) –

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

# Method Detail

## CreateClippingBoxesListItemBuilder

`PointCloudBuilder.``CreateClippingBoxesListItemBuilder`

  Creates a `Display.PointCloudClippingBoxesListItemBuilder`.

  Signature `CreateClippingBoxesListItemBuilder()`

  Returns: |
  Return type: | `NXOpen.Display.PointCloudClippingBoxesListItemBuilder`

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## LoadPointData

`PointCloudBuilder.``LoadPointData`

  Loads the selected point cloud data now.

  Signature `LoadPointData()`

  New in version NX11.0.0.

  License requirements: nx_point_cloud_view (“NX Point Cloud Viewer”)

## Validate

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