Inheritance diagram for HPS.PointCloud.ImportOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.PointCloud.ImportOptionsKit in_kit)
 
override int GetHashCode ()
 
 ImportOptionsKit ()
 
 ImportOptionsKit (HPS.PointCloud.ImportOptionsKit in_kit)
 
override HPS.Type ObjectType ()
 
void Set (HPS.PointCloud.ImportOptionsKit in_kit)
 
HPS.PointCloud.ImportOptionsKit SetPointColor (HPS.RGBColor in_color, bool in_override)
 
HPS.PointCloud.ImportOptionsKit SetPointColor (HPS.RGBColor in_color)
 
HPS.PointCloud.ImportOptionsKit SetSegment (HPS.SegmentKey in_segment)
 
void Show (out HPS.PointCloud.ImportOptionsKit out_kit)
 
bool ShowPointColor (out HPS.RGBColor out_color, out bool out_override)
 
bool ShowSegment (out HPS.SegmentKey out_segment)
 
HPS.PointCloud.ImportOptionsKit UnsetEverything ()
 
HPS.PointCloud.ImportOptionsKit UnsetPointColor ()
 
HPS.PointCloud.ImportOptionsKit UnsetSegment ()
 
- Public Member Functions inherited from HPS.Kit
Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.PointCloud.ImportOptionsKit a, HPS.PointCloud.ImportOptionsKit b)
 
static bool operator== (HPS.PointCloud.ImportOptionsKit a, HPS.PointCloud.ImportOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/2]

HPS.PointCloud.ImportOptionsKit.ImportOptionsKit ( )
inline

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/2]

HPS.PointCloud.ImportOptionsKit.ImportOptionsKit ( HPS.PointCloud.ImportOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ImportOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.PointCloud.ImportOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ImportOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.PointCloud.ImportOptionsKit.Equals ( HPS.PointCloud.ImportOptionsKit  in_kit)
inline

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to compare to this ImportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ ObjectType()

override HPS.Type HPS.PointCloud.ImportOptionsKit.ObjectType ( )
inlinevirtual

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).

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

Reimplemented from HPS.Kit.

◆ Set()

void HPS.PointCloud.ImportOptionsKit.Set ( HPS.PointCloud.ImportOptionsKit  in_kit)
inline

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetPointColor() [1/2]

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

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.

Parameters
in_colorThe color to use.
in_overrideSpecifies whether to override the point colors specified in the file (if any) with the color provided
Returns
A reference to this ImportOptionsKit.

◆ SetPointColor() [2/2]

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

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.

Parameters
in_colorThe color to use.
Returns
A reference to this ImportOptionsKit.

◆ SetSegment()

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

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.

Parameters
in_segmentSegment the point cloud data will be imported into.
Returns
A reference to this ImportOptionsKit.

◆ Show()

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

Parameters
out_kitThe ImportOptionsKit to populate with the contents of this ImportOptionsKit.

◆ ShowPointColor()

bool HPS.PointCloud.ImportOptionsKit.ShowPointColor ( out HPS.RGBColor  out_color,
out bool  out_override 
)
inline

Shows the point color to use during import.

Parameters
out_colorThe color being used.
out_overrideSpecifies whether the point colors specified in the file (if any) will be override with the color provided
Returns
true if a root segment was specified, false otherwise.

◆ ShowSegment()

bool HPS.PointCloud.ImportOptionsKit.ShowSegment ( out HPS.SegmentKey  out_segment)
inline

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

Parameters
out_segmentSegment the HSF data will be imported into.
Returns
true if a root segment was specified, false otherwise.

◆ UnsetEverything()

HPS.PointCloud.ImportOptionsKit HPS.PointCloud.ImportOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetPointColor()

HPS.PointCloud.ImportOptionsKit HPS.PointCloud.ImportOptionsKit.UnsetPointColor ( )
inline

Remove the point color to use during import.

Returns
A reference to this ImportOptionsKit.

◆ UnsetSegment()

HPS.PointCloud.ImportOptionsKit HPS.PointCloud.ImportOptionsKit.UnsetSegment ( )
inline

Removes the root segment speciyfing where the point cloud data will be imported into.

Returns
A reference to this ImportOptionsKit.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.PointCloud.cs