#include <hps.h>

Inheritance diagram for HPS::Kit:
HPS::Object HPS::ApplicationWindowOptionsKit HPS::AttributeLockKit HPS::BoundingKit HPS::CameraKit HPS::CircleKit HPS::CircularArcKit HPS::CircularWedgeKit HPS::ColorInterpolationKit HPS::ContourLineKit HPS::CullingKit HPS::CurveAttributeKit HPS::CutGeometryGatheringOptionsKit HPS::CuttingSectionAttributeKit HPS::CuttingSectionKit HPS::CylinderAttributeKit HPS::CylinderKit HPS::DebuggingKit HPS::DistantLightKit HPS::DrawingAttributeKit HPS::EdgeAttributeKit HPS::EllipseKit HPS::EllipticalArcKit HPS::GlyphKit HPS::GridKit HPS::Hardcopy::File::ExportOptionsKit HPS::Hardcopy::GDI::ExportOptionsKit HPS::HiddenLineAttributeKit HPS::HighlightOptionsKit HPS::HighlightSearchOptionsKit HPS::Image::ExportOptionsKit HPS::Image::ImportOptionsKit HPS::ImageKit HPS::InfiniteLineKit HPS::LightingAttributeKit HPS::LineAttributeKit HPS::LineKit HPS::LinePatternKit HPS::LinePatternOptionsKit HPS::LinePatternParallelKit HPS::MarkerAttributeKit HPS::MarkerKit HPS::MaterialKit HPS::MaterialMappingKit HPS::MeshKit HPS::NURBSCurveKit HPS::NURBSSurfaceAttributeKit HPS::NURBSSurfaceKit HPS::OBJ::ImportOptionsKit HPS::OBJ::ImportResultsKit HPS::OffScreenWindowOptionsKit HPS::PBRMaterialKit HPS::PerformanceKit HPS::PointCloud::ImportOptionsKit HPS::PointCloud::ImportResultsKit HPS::PolygonKit HPS::PostProcessEffectsKit HPS::SearchOptionsKit HPS::SegmentOptimizationOptionsKit HPS::SelectabilityKit HPS::SelectionOptionsKit HPS::ShapeKit HPS::ShellKit HPS::ShellOptimizationOptionsKit HPS::ShellRelationOptionsKit HPS::ShellRelationResultsKit HPS::SphereAttributeKit HPS::SphereKit HPS::SpotlightKit HPS::StandAloneWindowOptionsKit HPS::STL::ImportOptionsKit HPS::STL::ImportResultsKit HPS::Stream::ExportOptionsKit HPS::Stream::ImportOptionsKit HPS::Stream::ImportResultsKit HPS::SubwindowKit HPS::TextAttributeKit HPS::TextKit HPS::TextureOptionsKit HPS::TransformMaskKit HPS::TransparencyKit HPS::TrimKit HPS::UpdateOptionsKit HPS::VisibilityKit HPS::VisualEffectsKit HPS::WindowInfoKit

Public Member Functions

HPS::Type ObjectType () const
 
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Protected Member Functions

 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Detailed Description

The Kit class is the base class for all Visualize kits.

Constructor & Destructor Documentation

◆ Kit()

HPS::Kit::Kit ( Kit &&  in_that)
inlineprotected

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

Parameters
in_thatAn rvalue reference to a Kit to take the impl from.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::Kit::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::Object.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::GDI::ExportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::PBRMaterialKit, HPS::MaterialMappingKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, and HPS::SegmentOptimizationOptionsKit.

◆ operator=()

Kit& HPS::Kit::operator= ( Kit &&  in_that)
inlineprotected

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

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

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Object.


The documentation for this class was generated from the following file: