HPS::PointCloud::ImportOptionsKit Class Reference

#include <hps.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (ImportOptionsKit const &in_kit) const
 
 ImportOptionsKit ()
 
 ImportOptionsKit (ImportOptionsKit const &in_kit)
 
 ImportOptionsKit (ImportOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ImportOptionsKit const &in_kit) const
 
ImportOptionsKitoperator= (ImportOptionsKit &&in_that)
 
ImportOptionsKitoperator= (ImportOptionsKit const &in_kit)
 
bool operator== (ImportOptionsKit const &in_kit) const
 
void Set (ImportOptionsKit const &in_kit)
 
ImportOptionsKitSetPointColor (RGBColor const &in_color, bool in_override=false)
 
ImportOptionsKitSetSegment (SegmentKey const &in_segment)
 
void Show (ImportOptionsKit &out_kit) const
 
bool ShowPointColor (RGBColor &out_color, bool &out_override) const
 
bool ShowSegment (SegmentKey &out_segment) const
 
ImportOptionsKitUnsetEverything ()
 
ImportOptionsKitUnsetPointColor ()
 
ImportOptionsKitUnsetSegment ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::PointCloudImportOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

HPS::PointCloud::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/3]

HPS::PointCloud::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ ImportOptionsKit() [3/3]

HPS::PointCloud::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit &&  in_that)

The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::PointCloud::ImportOptionsKit::Empty ( ) const
virtual

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 ( ImportOptionsKit const &  in_kit) const

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

HPS::Type HPS::PointCloud::ImportOptionsKit::ObjectType ( ) const
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.

◆ operator!=()

bool HPS::PointCloud::ImportOptionsKit::operator!= ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.

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

◆ operator=() [1/2]

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::operator= ( ImportOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.
Returns
A reference to this ImportOptionsKit.

◆ operator=() [2/2]

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::operator= ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.
Returns
A reference to this ImportOptionsKit.

◆ operator==()

bool HPS::PointCloud::ImportOptionsKit::operator== ( ImportOptionsKit const &  in_kit) const

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.

◆ Set()

void HPS::PointCloud::ImportOptionsKit::Set ( ImportOptionsKit const &  in_kit)

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetPointColor()

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::SetPointColor ( RGBColor const &  in_color,
bool  in_override = false 
)

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.

◆ SetSegment()

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::SetSegment ( SegmentKey const &  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.

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

◆ Show()

void HPS::PointCloud::ImportOptionsKit::Show ( ImportOptionsKit out_kit) const

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 ( RGBColor out_color,
bool &  out_override 
) const

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 ( SegmentKey out_segment) const

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

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetPointColor()

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::UnsetPointColor ( )

Remove the point color to use during import.

Returns
A reference to this ImportOptionsKit.

◆ UnsetSegment()

ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::UnsetSegment ( )

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: