NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::Display::PointCloudBuilder Class Reference

Represents a Display::PointCloudBuilder . More...

Inheritance diagram for NXOpen::Display::PointCloudBuilder:
NXOpen::Builder NXOpen::TaggedObject NXOpen::GeometricUtilities::IComponentBuilder

Public Types

enum  BrightnessModes { BrightnessModesUniform, BrightnessModesShaded }
 Specifies point cloud brightness display mode choice. More...
 
enum  ColorModes { ColorModesIndividual, ColorModesUniform }
 Specifies point cloud color display mode choice. More...
 

Public Member Functions

NXOpen::Display::PointCloudClippingBoxesListItemBuilderListClippingBoxesList ()
 Returns the list of NXOpen::Display::PointCloudClippingBoxesListItemBuilder defining the clipping boxes parameters. More...
 
NXOpen::Display::PointCloudClippingBoxesListItemBuilderCreateClippingBoxesListItemBuilder ()
 Creates a Display::PointCloudClippingBoxesListItemBuilder . More...
 
void LoadPointData ()
 Loads the selected point cloud data now. More...
 
bool LoadPointDataWithPart ()
 Returns the indication if the point cloud data will be loaded with part load. More...
 
NXOpen::Display::PointCloudBuilder::BrightnessModes PointBrightnessMode ()
 Returns the point brightness display mode
Created in NX11.0.0. More...
 
NXOpen::Display::PointCloudBuilder::ColorModes PointColorMode ()
 Returns the point color display mode
Created in NX11.0.0. More...
 
NXString PointDataFile ()
 Returns the point cloud data file. More...
 
double PointDensity ()
 Returns the point density
Created in NX11.0.0. More...
 
int PointSize ()
 Returns the point size
Created in NX11.0.0. More...
 
void SetLoadPointDataWithPart (bool loadPointDataWithPart)
 Sets the indication if the point cloud data will be loaded with part load. More...
 
void SetPointBrightnessMode (NXOpen::Display::PointCloudBuilder::BrightnessModes pointBrightnessMode)
 Sets the point brightness display mode
Created in NX11.0.0. More...
 
void SetPointColorMode (NXOpen::Display::PointCloudBuilder::ColorModes pointColorMode)
 Sets the point color display mode
Created in NX11.0.0. More...
 
void SetPointDataFile (const NXString &filename)
 Sets the point cloud data file. More...
 
void SetPointDataFile (const char *filename)
 Sets the point cloud data file. More...
 
void SetPointDensity (double pointDensity)
 Sets the point density
Created in NX11.0.0. More...
 
void SetPointSize (int pointSize)
 Sets the point size
Created in NX11.0.0. More...
 
- Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObjectCommit ()
 Commits any edits that have been applied to the builder. More...
 
void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
std::vector< NXOpen::NXObject * > GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
NXOpen::NXObjectGetObject ()
 Returns the object currently being edited by this builder. More...
 
void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
virtual bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 
- Public Member Functions inherited from NXOpen::TaggedObject
tag_t Tag () const
 Returns the tag of this object. More...
 

Detailed Description

Represents a Display::PointCloudBuilder .

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


Created in NX11.0.0.

Member Enumeration Documentation

Specifies point cloud brightness display mode choice.

Enumerator
BrightnessModesUniform 

uniform

BrightnessModesShaded 

Shaded.

Specifies point cloud color display mode choice.

Enumerator
ColorModesIndividual 

individual

ColorModesUniform 

uniform

Member Function Documentation

NXOpen::Display::PointCloudClippingBoxesListItemBuilderList* NXOpen::Display::PointCloudBuilder::ClippingBoxesList ( )

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


Created in NX11.0.0.

License requirements : None

NXOpen::Display::PointCloudClippingBoxesListItemBuilder* NXOpen::Display::PointCloudBuilder::CreateClippingBoxesListItemBuilder ( )

Creates a Display::PointCloudClippingBoxesListItemBuilder .

Returns

Created in NX11.0.0.

License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")
void NXOpen::Display::PointCloudBuilder::LoadPointData ( )

Loads the selected point cloud data now.


Created in NX11.0.0.

License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

bool NXOpen::Display::PointCloudBuilder::LoadPointDataWithPart ( )

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


Created in NX11.0.0.

License requirements : None

NXOpen::Display::PointCloudBuilder::BrightnessModes NXOpen::Display::PointCloudBuilder::PointBrightnessMode ( )

Returns the point brightness display mode
Created in NX11.0.0.



License requirements : None

NXOpen::Display::PointCloudBuilder::ColorModes NXOpen::Display::PointCloudBuilder::PointColorMode ( )

Returns the point color display mode
Created in NX11.0.0.



License requirements : None

NXString NXOpen::Display::PointCloudBuilder::PointDataFile ( )

Returns the point cloud data file.


Created in NX11.0.0.

License requirements : None

double NXOpen::Display::PointCloudBuilder::PointDensity ( )

Returns the point density
Created in NX11.0.0.



License requirements : None

int NXOpen::Display::PointCloudBuilder::PointSize ( )

Returns the point size
Created in NX11.0.0.



License requirements : None

void NXOpen::Display::PointCloudBuilder::SetLoadPointDataWithPart ( bool  loadPointDataWithPart)

Sets the indication if the point cloud data will be loaded with part load.


Created in NX11.0.0.

License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
loadPointDataWithPartloadpointdatawithpart
void NXOpen::Display::PointCloudBuilder::SetPointBrightnessMode ( NXOpen::Display::PointCloudBuilder::BrightnessModes  pointBrightnessMode)

Sets the point brightness display mode
Created in NX11.0.0.



License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
pointBrightnessModepointbrightnessmode
void NXOpen::Display::PointCloudBuilder::SetPointColorMode ( NXOpen::Display::PointCloudBuilder::ColorModes  pointColorMode)

Sets the point color display mode
Created in NX11.0.0.



License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
pointColorModepointcolormode
void NXOpen::Display::PointCloudBuilder::SetPointDataFile ( const NXString filename)

Sets the point cloud data file.


Created in NX11.0.0.

License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
filenamefilename
void NXOpen::Display::PointCloudBuilder::SetPointDataFile ( const char *  filename)

Sets the point cloud data file.


Created in NX11.0.0.

License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
filenamefilename
void NXOpen::Display::PointCloudBuilder::SetPointDensity ( double  pointDensity)

Sets the point density
Created in NX11.0.0.



License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
pointDensitypointdensity
void NXOpen::Display::PointCloudBuilder::SetPointSize ( int  pointSize)

Sets the point size
Created in NX11.0.0.



License requirements : nx_point_cloud_view ("NX Point Cloud Viewer")

Parameters
pointSizepointsize

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.