#include <hps.h>

Inheritance diagram for HPS::Object:
HPS::ApplicationWindowOptionsKit HPS::AttributeLockKit HPS::BoundingKit HPS::CameraKit HPS::CircleKit HPS::CircularArcKit HPS::CircularWedgeKit HPS::ColorInterpolationKit HPS::ConditionalExpression HPS::ContourLineKit HPS::Control HPS::CullingKit HPS::CurveAttributeKit HPS::CutGeometryGatheringOptionsKit HPS::CuttingSectionAttributeKit HPS::CuttingSectionKit HPS::CylinderAttributeKit HPS::CylinderKit HPS::DebuggingKit HPS::Definition HPS::DistantLightKit HPS::DrawingAttributeKit HPS::DriverEventHandler HPS::EdgeAttributeKit HPS::EllipseKit HPS::EllipticalArcKit HPS::EventDispatcher HPS::EventHandler HPS::EventNotifier HPS::FontInfoState HPS::FontSearchResults HPS::FontSearchResultsIterator HPS::GlyphElement HPS::GlyphKit HPS::GridKit HPS::Hardcopy::File::ExportOptionsKit HPS::Hardcopy::GDI::ExportOptionsKit HPS::HiddenLineAttributeKit HPS::HighlightOptionsKit HPS::Image::ExportOptionsKit HPS::Image::ImportOptionsKit HPS::ImageKit HPS::InfiniteLineKit HPS::IONotifier HPS::Key HPS::KeyboardState HPS::KeyPath HPS::LightingAttributeKit HPS::LineAttributeKit HPS::LineKit HPS::LinePatternElement HPS::LinePatternKit HPS::LinePatternOptionsKit HPS::LinePatternParallelKit HPS::MarkerAttributeKit HPS::MarkerKit HPS::MaterialKit HPS::MaterialMappingKit HPS::MatrixKit HPS::MeshKit HPS::MouseState 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::SearchResults HPS::SearchResultsIterator HPS::SegmentOptimizationOptionsKit HPS::SelectabilityKit HPS::SelectionControl HPS::SelectionItem HPS::SelectionOptionsKit HPS::SelectionResults HPS::SelectionResultsIterator HPS::ShapeElement HPS::ShapeKit HPS::ShellKit HPS::ShellOptimizationOptionsKit HPS::ShellRelationOptionsKit HPS::ShellRelationResultsKit HPS::SphereAttributeKit HPS::SphereKit HPS::SpotlightKit HPS::Sprocket HPS::StandAloneWindowOptionsKit HPS::STL::ImportOptionsKit HPS::STL::ImportResultsKit HPS::Stream::ExportOptionsKit HPS::Stream::ImportOptionsKit HPS::Stream::ImportResultsKit HPS::Stream::Toolkit HPS::SubwindowKit HPS::TextAttributeKit HPS::TextKit HPS::TextureOptionsKit HPS::TouchState HPS::TransformMaskKit HPS::TransparencyKit HPS::TreeContext HPS::TrimElement HPS::TrimKit HPS::UpdateNotifier HPS::UpdateOptionsKit HPS::VisibilityKit HPS::VisualEffectsKit HPS::WindowInfoKit HPS::World

Public Member Functions

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)
 
virtual HPS::Type ObjectType () const
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
HPS::Type Type () const
 

Static Public Member Functions

template<typename T >
static intptr_t ClassID ()
 

Friends

class HPSI::Impl
 
class HPSI::KeyImpl
 
class HPSI::TicketImpl
 

Detailed Description

The Object class is the common base class of most Visualize classes.

Constructor & Destructor Documentation

HPS::Object::Object ( Object &&  in_that)

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

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

Member Function Documentation

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

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.

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

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::GDI::ExportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, 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::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::Publish::ListBoxKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Publish::TableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, 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::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

intptr_t HPS::Object::GetClassID ( ) const

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.
intptr_t HPS::Object::GetInstanceID ( ) const

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.
bool HPS::Object::HasType ( HPS::Type  in_mask) const

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.
virtual HPS::Type HPS::Object::ObjectType ( ) const
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 in HPS::STL::ImportNotifier, HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportNotifier, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::GDI::ExportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportNotifier, HPS::Stream::ImportNotifier, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::Stream::Toolkit, HPS::PointCloud::ImportNotifier, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::IONotifier, HPS::KeyboardState, HPS::TouchState, HPS::MouseState, HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::UpdateOptionsControl, HPS::UpdateOptionsKit, HPS::HighlightControl, HPS::HighlightOptionsKit, HPS::SelectionControl, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::SelectionItem, HPS::SelectionOptionsControl, HPS::SelectionOptionsKit, HPS::TreeContext, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeDefinition, HPS::ShapeKit, HPS::LinePatternDefinition, HPS::MaterialPaletteDefinition, HPS::NamedStyleDefinition, HPS::CubeMapDefinition, HPS::ImageDefinition, HPS::OffScreenWindowKey, HPS::OffScreenWindowOptionsControl, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::TextureDefinition, HPS::GlyphDefinition, HPS::PortfolioKey, HPS::Definition, HPS::LineShapeElement, HPS::AnchorShapeElement, HPS::CircularArcShapeElement, HPS::EllipticalArcShapeElement, HPS::CircleShapeElement, HPS::EllipseShapeElement, HPS::PolygonShapeElement, HPS::ShapeElement, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::GlyphLinePatternElement, HPS::BlankLinePatternElement, HPS::SolidLinePatternElement, HPS::LinePatternElement, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::InfiniteLineGlyphElement, HPS::CircularArcGlyphElement, HPS::SphereGlyphElement, HPS::EllipseGlyphElement, HPS::DotGlyphElement, HPS::LineGlyphElement, HPS::GlyphElement, HPS::ApplicationWindowKey, HPS::StandAloneWindowKey, HPS::ApplicationWindowOptionsControl, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsControl, HPS::StandAloneWindowOptionsKit, HPS::ReferenceKey, HPS::StyleKey, HPS::IncludeKey, HPS::GridKey, HPS::GridKit, HPS::PolygonKey, HPS::PolygonKit, HPS::MeshKey, HPS::MeshKit, HPS::ShellKey, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKey, HPS::TextKit, HPS::EllipticalArcKey, HPS::EllipticalArcKit, HPS::EllipseKey, HPS::EllipseKit, HPS::TrimKit, HPS::TrimElement, HPS::NURBSSurfaceKey, HPS::NURBSSurfaceKit, HPS::NURBSCurveKey, HPS::NURBSCurveKit, HPS::SpotlightKey, HPS::SpotlightKit, HPS::InfiniteLineKey, HPS::InfiniteLineKit, HPS::CuttingSectionKey, HPS::CuttingSectionKit, HPS::CircularWedgeKey, HPS::CircularWedgeKit, HPS::CircularArcKey, HPS::CircularArcKit, HPS::CircleKey, HPS::CircleKit, HPS::SphereKey, HPS::SphereKit, HPS::CylinderKey, HPS::CylinderKit, HPS::DistantLightKey, HPS::DistantLightKit, HPS::MarkerKey, HPS::MarkerKit, HPS::LineKey, HPS::LineKit, HPS::GeometryKey, HPS::AttributeLockControl, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoControl, HPS::WindowInfoKit, HPS::DebuggingControl, HPS::DebuggingKit, HPS::SubwindowControl, HPS::SubwindowKit, HPS::ContourLineControl, HPS::ContourLineKit, HPS::VisualEffectsControl, HPS::VisualEffectsKit, HPS::TransformMaskControl, HPS::TransformMaskKit, HPS::PostProcessEffectsControl, HPS::PostProcessEffectsKit, HPS::DrawingAttributeControl, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeControl, HPS::HiddenLineAttributeKit, HPS::PerformanceControl, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeControl, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::MaterialMappingKit, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::MatrixKit, HPS::CurveAttributeControl, HPS::CurveAttributeKit, HPS::EdgeAttributeControl, HPS::EdgeAttributeKit, HPS::LineAttributeControl, HPS::LineAttributeKit, HPS::TextAttributeControl, HPS::TextAttributeKit, HPS::CuttingSectionAttributeControl, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeControl, HPS::CylinderAttributeKit, HPS::LightingAttributeControl, HPS::LightingAttributeKit, HPS::SphereAttributeControl, HPS::SphereAttributeKit, HPS::MarkerAttributeControl, HPS::MarkerAttributeKit, HPS::CullingControl, HPS::CullingKit, HPS::ColorInterpolationControl, HPS::ColorInterpolationKit, HPS::TransparencyControl, HPS::TransparencyKit, HPS::SelectabilityControl, HPS::SelectabilityKit, HPS::CameraControl, HPS::CameraKit, HPS::VisibilityControl, HPS::VisibilityKit, HPS::BoundingControl, HPS::BoundingKit, HPS::KeyPath, HPS::WindowKey, HPS::DriverEventHandler, HPS::UpdateNotifier, HPS::SegmentOptimizationOptionsKit, HPS::SegmentKey, HPS::Key, HPS::ConditionalExpression, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, HPS::Publish::ExportOptionsKit, HPS::SearchResultsIterator, HPS::EventNotifier, HPS::Publish::PageControl, HPS::Publish::DocumentKey, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Publish::ListBoxKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::ComponentTreeItem, HPS::Publish::LinkKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::ComponentTree, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::SceneTreeItem, HPS::Exchange::ExportIGESOptionsKit, HPS::Publish::TableKit, HPS::SceneTree, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::BooleanMetadata, HPS::Exchange::TranslationOptionsKit, HPS::TimeMetadata, HPS::Publish::ArtworkKit, HPS::StringMetadata, HPS::DoubleMetadata, HPS::UnsignedIntegerMetadata, HPS::IntegerMetadata, HPS::Metadata, HPS::CADModel, HPS::Capture, HPS::Publish::AnnotationKit, HPS::Filter, HPS::ComponentPath, HPS::Component, HPS::Exchange::ImportOptionsKit, HPS::AxisTriadControl, HPS::Parasolid::ExportOptionsKit, HPS::NavigationCubeControl, HPS::Exchange::NURBSConversionOptionsKit, HPS::OperatorControl, HPS::Parasolid::LineTessellationKit, HPS::Operator, HPS::Exchange::Configuration, HPS::SprocketPath, HPS::Publish::PageKit, HPS::Exchange::ReloadNotifier, HPS::Parasolid::FacetTessellationKit, HPS::Exchange::ExportNotifier, HPS::Publish::DocumentKit, HPS::Exchange::TranslationNotifier, HPS::Exchange::ImportNotifier, HPS::Layout, HPS::Parasolid::ImportOptionsKit, HPS::Exchange::Filter, HPS::Model, HPS::Parasolid::ImportNotifier, HPS::Exchange::Capture, HPS::Parasolid::CADModel, HPS::Exchange::CADModel, HPS::Parasolid::Component, HPS::Exchange::Sheet, HPS::View, HPS::SprocketControl, HPS::Exchange::ProductOccurrence, HPS::Sketchup::ImportOptionsKit, HPS::Sketchup::ImportNotifier, HPS::Exchange::Component, HPS::Canvas, HPS::ExchangeParasolid::ImportNotifier, and HPS::Sketchup::ImportResultsKit.

Object& HPS::Object::operator= ( Object &&  in_that)

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

Parameters
in_thatAn rvalue reference to an Object to take the impl from.
Returns
A reference to this Object.
virtual void HPS::Object::Reset ( )
virtual
HPS::Type HPS::Object::Type ( ) const

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.

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