HPS::PointCloud::ImportResultsKit

class HPS::PointCloud::ImportResultsKit : public HPS::Kit

The ImportResultsKit class contains the results of a successful point cloud import.

Public Functions

virtual bool Empty() const

Indicates whether this ImportResultsKit has any values set on it.

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

bool Equals(ImportResultsKit const &in_kit) const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters: in_kit – The source ImportResultsKit to compare to this ImportResultsKit.
Returns: true if the objects are equivalent, false otherwise.

ImportResultsKit(): The default constructor creates an empty ImportResultsKit object.

ImportResultsKit(ImportResultsKit &&in_that)

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

Parameters: in_that – An rvalue reference to an ImportResultsKit to take the impl from.

ImportResultsKit(ImportResultsKit const &in_kit)

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

Parameters: in_kit – The source ImportResultsKit to copy.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(ImportResultsKit const &in_kit) const

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

Parameters: in_kit – The source ImportResultsKit to compare to this ImportResultsKit.
Returns: true if the objects are not equivalent, false otherwise.

ImportResultsKit &operator=(ImportResultsKit &&in_that)

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

Parameters: in_that – An rvalue reference to an ImportResultsKit to take the impl from.
Returns: A reference to this ImportResultsKit.

ImportResultsKit &operator=(ImportResultsKit const &in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters: in_kit – The source ImportResultsKit to copy.
Returns: A reference to this ImportResultsKit.

bool operator==(ImportResultsKit const &in_kit) const

Check if the source ImportResultsKit is equivalent to this ImportResultsKit.

Parameters: in_kit – The source ImportResultsKit to compare to this ImportResultsKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(ImportResultsKit const &in_kit)

Copies the source ImportResultsKit into this ImportResultsKit.

Parameters: in_kit – The source ImportResultsKit to copy.

ImportResultsKit &SetSegment(SegmentKey const &in_segment)

Sets the root segment which the point cloud data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an point cloud import.

Parameters: in_segment – Segment the point cloud data was imported into.
Returns: A reference to this ImportResultsKit.

void Show(ImportResultsKit &out_kit) const

Copies this ImportResultsKit into the given ImportResultsKit.

Parameters: out_kit – The ImportResultsKit to populate with the contents of this ImportResultsKit.

bool ShowSegment(SegmentKey &out_segment) const

Shows the root segment which the point cloud data was imported into. This was either the root segment specified by the user in the ImportOptionsKit passed to OBJ::File::Import, or the root segment that was created for this purpose during import.

Parameters: out_segment – Segment the point cloud data was imported into.
Returns: true if a root segment was specified, false otherwise.

ImportResultsKit &UnsetEverything()

Removes all settings from this ImportResultsKit.

Returns: A reference to this ImportResultsKit.

ImportResultsKit &UnsetSegment()

Removes the root segment which the point cloud data was imported into. This is really only used when generating an ImportResultsKit which is being returned to a user following an point cloud import.

Returns: A reference to this ImportResultsKit.

virtual ~ImportResultsKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PointCloudImportResultsKit