HPS::PointCloud::ImportOptionsKit

class HPS.PointCloud.ImportOptionsKit : public HPS.Kit 

The ImportOptionsKit class contains any settings controlling the import of XYZ, PTX, and PTS files.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ImportOptionsKit has any values set on it.

Return: true if no values are set on this ImportOptionsKit, false otherwise.

bool Equals (HPS.PointCloud.ImportOptionsKit in_kit)

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to compare to this ImportOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

override int GetHashCode ()

ImportOptionsKit (): The default constructor creates an empty ImportOptionsKit object.

ImportOptionsKit (HPS.PointCloud.ImportOptionsKit in_kit)

The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return: The declared type of the object in question, which may differ from the true, underlying type.

void Set (HPS.PointCloud.ImportOptionsKit in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Param in_kit: The source ImportOptionsKit to copy.

HPS.PointCloud.ImportOptionsKit SetPointColor (HPS.RGBColor in_color)

Sets the point color for each point in the cloud. If the point cloud explicitly provides colors for points this option will be ignored unless in_override is specified. If the file only describes an intensity for each point the color provided will be multilplied by the intensity to resolve the final point coloration unless in_override is specified in which case the intensity will be ignored. If the file describes no intensity or color (or in_override is specified), this will set the vertex color at the containing segment.

Param in_color: The color to use.
Return: A reference to this ImportOptionsKit.

HPS.PointCloud.ImportOptionsKit SetPointColor (HPS.RGBColor in_color, bool in_override)

Sets the point color for each point in the cloud. If the point cloud explicitly provides colors for points this option will be ignored unless in_override is specified. If the file only describes an intensity for each point the color provided will be multilplied by the intensity to resolve the final point coloration unless in_override is specified in which case the intensity will be ignored. If the file describes no intensity or color (or in_override is specified), this will set the vertex color at the containing segment.

Param in_color: The color to use.
Param in_override: Specifies whether to override the point colors specified in the file (if any) with the color provided
Return: A reference to this ImportOptionsKit.

HPS.PointCloud.ImportOptionsKit SetSegment (HPS.SegmentKey in_segment)

Sets the root segment where the point cloud data will be imported into. If no segment is specified, a root segment will be created for this purpose during import.

Param in_segment: Segment the point cloud data will be imported into.
Return: A reference to this ImportOptionsKit.

void Show (out HPS.PointCloud.ImportOptionsKit out_kit)

Copies this ImportOptionsKit into the given ImportOptionsKit.

Param out_kit: The ImportOptionsKit to populate with the contents of this ImportOptionsKit.

bool ShowPointColor (out HPS.RGBColor out_color, out bool out_override)

Shows the point color to use during import.

Param out_color: The color being used.
Param out_override: Specifies whether the point colors specified in the file (if any) will be override with the color provided
Return: true if a root segment was specified, false otherwise.

bool ShowSegment (out HPS.SegmentKey out_segment)

Shows the root segment where the HSF data will be imported into.