HPS::Object Class Reference

#include <hps.h>

Inheritance diagram for HPS::Object:

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

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::None

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

Object()

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_that

An rvalue reference to an Object to take the impl from.

Member Function Documentation

ClassID()

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.

Empty()

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

inlinevirtual

Indicates whether this object has any values set on it.

Note

An empty object is not necessarily invalid. For example, all fresh new Kits, or Objects that have been reset, are both valid and empty.

Returns

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

See also

HPS::Object::Reset()

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::LegacyShaderKit, HPS::LegacyShader::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::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, HPS::KeyPath, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::DataTableKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::TextFieldKit, HPS::Exchange::ExportGLTFOptionsKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Publish::SignatureFieldKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Publish::DropDownListKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportOBJOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportJTOptionsKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportFBXOptionsKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ButtonKit, HPS::Publish::LinkKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::TableKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Publish::ViewKit, HPS::ComponentPath, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::Exchange::ImportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::Configuration, HPS::Parasolid::LineTessellationKit, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::HCA::NetworkImportOptionsKit, HPS::Sketchup::ImportOptionsKit, HPS::HCA::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

GetClassID()

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.

GetInstanceID()

intptr_t HPS::Object::GetInstanceID

(

)

const

Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. 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. This means it would be 4 bytes on a 32-bit system and 8 bytes on a 64-bit system.

HasType()

bool HPS::Object::HasType

(

HPS::Type

in_mask

)

const

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

Parameters

in_mask

The Type mask to check against this Object.

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

true if this Object has the given Type mask, false otherwise.

ObjectType()

virtual HPS::Type HPS::Object::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 in HPS::STL::ImportNotifier, HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ExportNotifier, 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::OptimizeMappingResults, HPS::OptimizeMappingResultsIterator, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::HighlightState, HPS::HighlightSearchOptionsKit, 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::LegacyShaderDefinition, HPS::LegacyShaderKit, HPS::LegacyShader::ImportOptionsKit, 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::LeaderLineClippingElement, 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::ImageGlyphElement, 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::PBRMaterialKit, HPS::MaterialMappingKit, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, 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::SearchResultsIterator, HPS::Publish::ExportOptionsKit, HPS::EventNotifier, HPS::Publish::PageControl, HPS::Publish::DocumentKey, HPS::Kit, HPS::Control, HPS::Publish::DataTableKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::TextFieldKit, HPS::Exchange::ExportGLTFOptionsKit, HPS::AnimationControl, HPS::Exchange::ExportSTEPOptionsKit, HPS::Publish::SignatureFieldKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::ComponentTreeItem, HPS::Exchange::ExportIGESOptionsKit, HPS::ComponentTree, HPS::Publish::DropDownListKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Exchange::ExportU3DOptionsKit, HPS::SceneTreeItem, HPS::Exchange::ExportOBJOptionsKit, HPS::Publish::ListBoxKit, HPS::SceneTree, HPS::Exchange::ExportSTLOptionsKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportJTOptionsKit, HPS::Exchange::ExportACISOptionsKit, HPS::BooleanMetadata, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportFBXOptionsKit, HPS::TimeMetadata, HPS::StringMetadata, HPS::DoubleMetadata, HPS::Exchange::Export3MFOptionsKit, HPS::UnsignedIntegerMetadata, HPS::IntegerMetadata, HPS::Metadata, HPS::Publish::ButtonKit, HPS::CADModel, HPS::Publish::LinkKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Capture, HPS::Filter, HPS::Publish::SlideTableKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::TableKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Publish::ViewKit, HPS::ComponentPath, HPS::Publish::ArtworkKit, HPS::Component, HPS::AxisTriadControl, HPS::NavigationCubeControl, HPS::Publish::AnnotationKit, HPS::OperatorControl, HPS::Exchange::ImportOptionsKit, HPS::Operator, HPS::SprocketPath, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::Configuration, HPS::Layout, HPS::Model, HPS::Parasolid::LineTessellationKit, HPS::Exchange::ReloadNotifier, HPS::View, HPS::SprocketKit, HPS::Exchange::ExportNotifier, HPS::SprocketControl, HPS::Exchange::TranslationNotifier, HPS::Publish::PageKit, HPS::Exchange::ImportNotifier, HPS::Canvas, HPS::Exchange::Layer, HPS::Animation, HPS::Exchange::Filter, HPS::Channel, HPS::HCA::ModelTreeItem, HPS::Exchange::Capture, HPS::Parasolid::FacetTessellationKit, HPS::FloatSampler, HPS::HCA::ModelTree, HPS::Exchange::CADModel, HPS::QuaternionSampler, HPS::Publish::DocumentKit, HPS::Exchange::Sheet, HPS::PointSampler, HPS::Parasolid::ImportOptionsKit, HPS::VectorSampler, HPS::Exchange::BIMData, HPS::Parasolid::ImportNotifier, HPS::Exchange::BIMType, HPS::RGBColorSampler, HPS::DWG::ImportOptionsKit, HPS::Parasolid::CADModel, HPS::Exchange::BIMRelationship, HPS::Sampler, HPS::DWG::ImportNotifier, HPS::Parasolid::Component, HPS::Exchange::BIMRelationshipEntity, HPS::OOC::ImportOptionsKit, HPS::Exchange::ProductOccurrence, HPS::DWG::Layout, HPS::OOC::ImportNotifier, HPS::HCA::NetworkImportOptionsKit, HPS::Sketchup::ImportOptionsKit, HPS::DWG::CADModel, HPS::Sketchup::ImportNotifier, HPS::Exchange::Component, HPS::DWG::Layer, HPS::HCA::ImportOptionsKit, HPS::DWG::Component, HPS::ExchangeParasolid::ImportNotifier, HPS::HCA::ImportNotifier, and HPS::Sketchup::ImportResultsKit.

operator=()

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_that

An rvalue reference to an Object to take the impl from.

Returns

A reference to this Object.

Reset()

virtual void HPS::Object::Reset ( )

virtual

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::OptimizeMappingResults, HPS::OptimizeMappingResultsIterator, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtual

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::Object::staticType = HPS::Type::None

static

Returned by ObjectType()

---

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

• include/hps.h