ITerrainPointCloudModel80

Objects that implement this interface use an external file that defines a point cloud model rendered on the terrain. These models are created from a list of points in a 3D area that are collected by various 3D scanners.

 

 

Properties

 

Action

An IAction80 representing the operation that takes place when the object is clicked in the Project Tree.

Attachment

An IAttachment80 representing the attachment behavior of the model.

DataFormat

Gets the type of point data.

DefaultLocation

An IPointCloudDefaultLocation80 representing the default location for the model.

FlattenBelowTerrain

Gets and sets a Boolean that determines whether the terrain under the model is leveled to the model's elevation value.

HideBelowImagery

Gets and sets a Boolean that determines whether the terrain database imagery is displayed below the model.

ID

Gets the ID of the object. (Inherited from ITerraExplorerObject80)

IntensityBlend

Gets and sets the degree the point cloud’s intensity value is factored in colorizing the point cloud.

MaxIntensity

Gets and sets the maximum intensity value applied to the model.

Message

An IMessageObject80 representing the message object assigned to the model.

MinIntensity

Gets and sets the minimum intensity value applied to the model.

ModelFileName

Gets and sets a full path name or a URL to the point cloud model file that this object should use.

ObjectType

Gets an enum that identifies the type of the object. (Inherited from ITerraExplorerObject80)

PointColor

An IColor80 representing the color of each sampled point.

PointSamplingInterval

Gets and sets the accuracy level by which the model is read.

PointSize

Gets and sets the size, in pixels, of each of the point cloud’s points.

Position

An IPosition80 representing the position and orientation of the object on the terrain.

SaveInFlyFile

Gets and sets a Boolean that determines whether the object should be saved in the Fly file. (Inherited from ITerraExplorerObject80)

ScaleFactor

Gets and sets the factor by which to scale the point cloud model.

Terrain

An ITerrainObject80 representing terrain properties including draw order and ground object status.

Timespan

An ITimeSpan80 representing the timespan in which the object is visible on the terrain.

Tooltip

An ITooltip80 representing the tooltip that displays when a mouse cursor is placed over the model in the 3D Window.

TreeItem

An ITreeItem80 describing the representation of the model in the Project Tree.

Visibility

An IVisibility80 representing the visibility of the model at different distances.

 

Methods

 

CopyStyleFrom

Copies the styles from a point cloud model in order to then paste them to another point cloud using the CopyStyleTo method.

CopyStyleTo

Pastes the styles that were copied from a point cloud model using the CopyStyleFrom method.

GetClassification

Returns the classification XML for a specified property for the point cloud.

GetClientData

Gets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)

GetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

IsClassified

Indicates if a classification XML was set for a specified property of the point cloud.

OpenStyleEditorDialog

Opens the Field by Attribute dialog box to control the appearance and behavior of point cloud features based on field attribute values.

SetClassification

Sets a classification XML for a specified property of the point cloud.

SetClientData

Sets an array of text strings assigned to each object global namespace. (Inherited from ITerraExplorerObject80)

SetParam

Reserved. Currently not used. (Inherited from ITerraExplorerObject80)

DataFormat

Gets the type of point data. The following are possible values:

§   CPT_DF_INTENSITY = 0

§   CPT_DF_RGB = 1

 

JavaScript

 

DataFormat

 

C#

 

CPTDataFormat DataFormat { get; }

 

C++

 

HRESULT DataFormat([out, retval] CPTDataFormat* pVal)

 

FlattenBelowTerrain

Gets and sets a Boolean that determines whether the terrain under the model is leveled to the model's elevation value. The terrain is flattened only if the object was created with AltitudeType value of ATC_TERRAIN_ABSOLUTE.

 

JavaScript

 

FlattenBelowTerrain

 

C#

 

bool FlattenBelowTerrain { get; set; }

 

C++

 

HRESULT FlattenBelowTerrain([out, retval] VARIANT_BOOL* pVal)

HRESULT FlattenBelowTerrain([in] VARIANT_BOOL pVal)

HideBelowImagery

Gets and sets a Boolean that determines whether the terrain database imagery is displayed below the model. When set to TRUE, the terrain under the model appears as black. When set to FALSE the terrain database imagery is displayed.

 

JavaScript

 

HideBelowImagery

 

C#

 

bool HideBelowImagery { get; set; }

 

C++

 

HRESULT HideBelowImagery([out, retval] VARIANT_BOOL* pVal)

HRESULT HideBelowImagery([in] VARIANT_BOOL pVal)

 

IntensityBlend

Gets and sets the degree the point cloud’s intensity value is factored in colorizing the point cloud. This value can be any value between 0, to colorize the point cloud model by point color only, and 1 to colorize it by intensity only.

 

JavaScript

 

IntensityBlend

 

C#

 

double IntensityBlend { get; set; }

 

C++

 

HRESULT IntensityBlend([out, retval] double* pVal)

HRESULT IntensityBlend([in] double pVal)

 

MaxIntensity

Gets and sets a value between 0 to 255, marking the maximum intensity value applied to the model. The value should be greater than the MinIntensity value.

 

JavaScript

 

MaxIntensity

 

C#

 

double MaxIntensity { get; set; }

 

C++

 

HRESULT MaxIntensity([out, retval] double* pVal)

HRESULT MaxIntensity([in] double pVal)

MinIntensity

Gets and sets a value between 0 to 255, marking the minimum intensity value applied to the model. The value should be smaller than the MaxIntensity value.

 

JavaScript

 

MinIntensity

 

C#

 

double MinIntensity { get; set; }

 

C++

 

HRESULT MinIntensity([out, retval] double* pVal)

HRESULT MinIntensity([in] double pVal)

ModelFileName

Gets and sets a full path name or a URL to the point cloud model file that this object should use.

 

JavaScript

 

ModelFileName

 

C#

 

string ModelFileName { get; set; }

 

C++

 

HRESULT ModelFileName([out, retval] BSTR* pVal)

HRESULT ModelFileName([in] BSTR pVal)

 

PointSamplingInterval

Gets and sets the accuracy level by which the model is read. When set to 1 the model is sampled in an optimal interval determined by TerraExplorer. To sample the model with less precision use larger values; this results in better performance. To sample the model with higher density, select values less than 1 (but greater than zero).

 

JavaScript

 

PointSamplingInterval

 

C#

 

double PointSamplingInterval { get; set; }

 

C++

 

HRESULT PointSamplingInterval([out, retval] double* pVal)

HRESULT PointSamplingInterval([in] double pVal)

PointSize

Gets and sets the size, in pixels, of each of the point cloud’s points.

 

JavaScript

 

PointSize

 

C#

 

double PointSize { get; set; }

 

C++

 

HRESULT PointSize([out, retval] double* pVal)

HRESULT PointSize([in] double pVal)

ScaleFactor

Gets and sets the factor by which to scale the point cloud model. The actual size of the model in the 3D World is the size of the model in its internal coordinate system multiplied by the ScaleFactor value (i.e., if the model has a width of 5 units and the scale is set to 10 meters per pixel, the width of the object in the 3D World is 50 meters).

 

JavaScript

 

ScaleFactor

 

C#

 

double ScaleFactor { get; set; }

 

C++

 

HRESULT ScaleFactor([out, retval] double* pVal)

HRESULT ScaleFactor([in] double pVal)

 

CopyStyleFrom

CopyStyleFrom copies the styles from a point cloud model in order to then paste the styles to a different point cloud model using the CopyStyleTo method. All properties are copied except for Name and the properties listed in the Model and Position sections of the point cloud property sheet.

 

JavaScript

 

CopyStyleFrom(PointCloudObjectID)

 

C#

 

void CopyStyleFrom (string PointCloudObjectID)

 

C++

 

HRESULT CopyStyleFrom ([in] BSTR PointCloudObjectID);

Parameters

PointCloudObjectID

ID of the point cloud model from which to copy the styles.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

CopyStyleTo

CopyStyleTo pastes the styles that were copied from a point cloud using the CopyStyleFrom method. All layer properties are pasted except for Name and the properties listed in the Model and Position sections of the point cloud property sheet.

 

JavaScript

 

CopyStyleTo(PointCloudObjectID)

 

C#

 

void CopyStyleTo (string PointCloudObjectID)

 

C++

 

HRESULT CopyStyleTo ([in] BSTR PointCloudObjectID);

Parameters

PointCloudObjectID

ID of the point cloud model to which to copy the styles.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

 

GetClassification

This method returns the classification XML for a specified property of the point cloud.

 

JavaScript

 

GetClassification(

       Name)

 

C#

 

string GetClassification(

       string Name)

 

C++

 

HRESULT GetClassification(

       BSTR Name,

       BSTR* pValue)

Parameters

Name

The name of the property. The parameter can be a name of any property field as it appears in the Layer property sheet in TerraExplorer (e.g., “Point Color”).

Return Value

pValue

A classification XML for the specified property. See: the SetClassification method description and see:“Feature Layers” chapter in the User Manual.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

IsClassified

This method indicates if a classification XML was set for a specified property of the point cloud.

 

JavaScript

 

IsClassified(

       Name)

 

C#

 

bool IsClassified(

       string Name)

 

C++

 

HRESULT IsClassified(

       BSTR Name,

       VARIANT_BOOL* pValue)

Parameters

Name

The name of the property to be checked. This parameter can be a name of any property field as it appears in the Layer property sheet in TerraExplorer (e.g., “Point Size”).

Return Value

pValue

A Boolean indicating whether a classification XML was set for the specified property.

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

OpenStyleEditorDialog

Opens the Field by Attribute dialog box to control the appearance and behavior of point cloud features based on field attribute values.

 

JavaScript

 

OpenStyleEditorDialog(

       Name)

 

C#

 

void OpenStyleEditorDialog (

       string Name)

 

C++

 

HRESULT OpenStyleEditorDialog (

       [in] BSTR Name)

Parameters

Name

The name of the property whose value is to be set based on attribute value. The parameter can be a name of any property field that can be styled based on attribute value, as it appears in the point cloud property sheet in TerraExplorer (e.g., “Line Color”).

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.

SetClassification

This method sets a classification XML for a specified property of the point cloud. Classification XML is used for persistence of a classification which is defined in the TerraExplorer Pro GUI. When a classification is defined using the Field by Attribute dialog box, you can use GetClassification to retrieve an XML that defines this classification. See “Feature Layers” chapter in the User Manual.

 

JavaScript

 

SetClassification(

       Name,

       Value)

 

C#

 

void SetClassification(

       string Name,

       string Value)

 

C++

 

HRESULT SetClassification(

       BSTR Name,

       BSTR Value)

Parameters

Name

The name of the property to be set. The parameter can be a name of any property field as it appears in the point cloud property sheet in TerraExplorer (e.g., “Point Color”).

Value

The value of the property. This parameter can be a classification XML.  

Exceptions

See: HRESULT Return Values for a list of possible values returned by the HRESULT.