#include <hps.h>

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 |
ImportOptionsKit & | operator= (ImportOptionsKit &&in_that) |
ImportOptionsKit & | operator= (ImportOptionsKit const &in_kit) |
bool | operator== (ImportOptionsKit const &in_kit) const |
void | Set (ImportOptionsKit const &in_kit) |
ImportOptionsKit & | SetPointColor (RGBColor const &in_color) |
ImportOptionsKit & | SetSegment (SegmentKey const &in_segment) |
void | Show (ImportOptionsKit &out_kit) const |
bool | ShowPointColor (RGBColor &out_color) const |
bool | ShowSegment (SegmentKey &out_segment) const |
ImportOptionsKit & | UnsetEverything () |
ImportOptionsKit & | UnsetPointColor () |
ImportOptionsKit & | UnsetSegment () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The ImportOptionsKit class contains any settings controlling the import of XYZ, PTX, and PTS files.
Constructor & Destructor Documentation
HPS::PointCloud::ImportOptionsKit::ImportOptionsKit | ( | ) |
The default constructor creates an empty ImportOptionsKit object.
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_kit The source ImportOptionsKit to copy.
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_that An rvalue reference to an ImportOptionsKit to take the impl from.
Member Function Documentation
|
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.
bool HPS::PointCloud::ImportOptionsKit::Equals | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
bool HPS::PointCloud::ImportOptionsKit::operator!= | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
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_that An rvalue reference to an ImportOptionsKit to take the impl from.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::operator= | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
- Returns
- A reference to this ImportOptionsKit.
bool HPS::PointCloud::ImportOptionsKit::operator== | ( | ImportOptionsKit const & | in_kit | ) | const |
Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to compare to this ImportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
void HPS::PointCloud::ImportOptionsKit::Set | ( | ImportOptionsKit const & | in_kit | ) |
Copies the source ImportOptionsKit into this ImportOptionsKit.
- Parameters
-
in_kit The source ImportOptionsKit to copy.
ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::SetPointColor | ( | RGBColor const & | 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. 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. If the file describes no intensity or color, this will set the vertex color at the containing segment.
- Parameters
-
in_color The color to use.
- Returns
- A reference to this ImportOptionsKit.
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_segment Segment the point cloud data will be imported into.
- Returns
- A reference to this ImportOptionsKit.
void HPS::PointCloud::ImportOptionsKit::Show | ( | ImportOptionsKit & | out_kit | ) | const |
Copies this ImportOptionsKit into the given ImportOptionsKit.
- Parameters
-
out_kit The ImportOptionsKit to populate with the contents of this ImportOptionsKit.
bool HPS::PointCloud::ImportOptionsKit::ShowPointColor | ( | RGBColor & | out_color | ) | const |
Shows the point color to use during import.
- Parameters
-
out_color The color being used.
- Returns
- true if a root segment was specified, false otherwise.
bool HPS::PointCloud::ImportOptionsKit::ShowSegment | ( | SegmentKey & | out_segment | ) | const |
Shows the root segment where the HSF data will be imported into.
- Parameters
-
out_segment Segment the HSF data will be imported into.
- Returns
- true if a root segment was specified, false otherwise.
ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ImportOptionsKit.
- Returns
- A reference to this ImportOptionsKit.
ImportOptionsKit& HPS::PointCloud::ImportOptionsKit::UnsetPointColor | ( | ) |
Remove the point color to use during import.
- Returns
- A reference to this ImportOptionsKit.
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:
- include/hps.h