Hoops Visualize HPS  version 2018-SP2
Hoops Visualize HPS 3D Rendering Engine
Looking for a senior C++ dev?
I'm looking for work. Hire me!
HPS::Kit Class Reference

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

#include <hps.h>

Inherits HPS::Object.

Inherited by 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::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::MatrixKit, HPS::MeshKit, HPS::NURBSCurveKit, HPS::NURBSSurfaceAttributeKit, HPS::NURBSSurfaceKit, HPS::OBJ::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OffScreenWindowOptionsKit, HPS::PerformanceKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::PolygonKit, HPS::PostProcessEffectsKit, HPS::SearchOptionsKit, HPS::SegmentOptimizationOptionsKit, HPS::SelectabilityKit, HPS::SelectionOptionsKit, HPS::Shader::ImportOptionsKit, HPS::ShaderKit, 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, and HPS::WindowInfoKit.

Collaboration diagram for HPS::Kit:

Public Member Functions

HPS::Type ObjectType () const
 
virtual HPS::Type Type () const
 This function returns the true type of the underlying object. More...
 
 Kit (Kit const &in_that)=default
 
virtual bool Empty () const
 Indicates whether this object has any values set on it. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS::Type in_mask) const
 This function indicates whether this Object has the given Type mask. More...
 
intptr_t GetClassID () const
 Returns a unique identifier that is shared by all objects of the same class. More...
 
intptr_t GetInstanceID () const
 Returns an identifier that can be used to identify which instance of a class an object is. More...
 

Static Public Member Functions

template<typename T >
static intptr_t ClassID ()
 Unique identifier for this class. More...
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::Kit
 

Protected Member Functions

 Kit ()
 
 Kit (Kit &&in_that)
 The move constructor creates a Kit by transferring the underlying impl of the rvalue reference to this Kit thereby avoiding a copy and allocation. More...
 
Kitoperator= (Kit &&in_that)
 The move assignment operator transfers the underlying impl of the rvalue reference to this Kit thereby avoiding a copy. More...
 

Detailed Description

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

Constructor & Destructor Documentation

◆ Kit() [1/3]

HPS::Kit::Kit ( Kit const &  in_that)
default

◆ Kit() [2/3]

HPS::Kit::Kit ( )
inlineprotected

◆ Kit() [3/3]

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

◆ ClassID()

template<typename T >
static intptr_t HPS::Object::ClassID ( )
inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ Empty()

virtual bool HPS::Object::Empty ( ) const
inlinevirtualinherited

Indicates whether this object has any values set on it.

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, 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::ShaderKit, HPS::Shader::ImportOptionsKit, 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::FontInfoState, 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::MaterialMappingKit, HPS::MatrixKit, 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, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const
inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns
A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const
inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns
A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type  in_mask) const
inherited

This function indicates whether this Object has the given Type mask.

Parameters
in_maskThe Type mask to check against this Object.
Returns
true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

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

Reimplemented from HPS::Object.

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, 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::ShaderKit, HPS::Shader::ImportOptionsKit, 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::MaterialMappingKit, HPS::MatrixKit, 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.
Here is the call graph for this function:

◆ Reset()

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

Returns
The true type of the object in question.

Reimplemented from HPS::Object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::Kit::staticType = HPS::Type::Kit
static

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