< Home

< Table of Contents

REFERENCE MANUAL

Object Class Reference

#include <hps.h>

Inheritance diagram for Object:
ApplicationWindowOptionsKit AttributeLockKit BoundingKit CameraKit CircleKit CircularArcKit CircularWedgeKit ColorInterpolationKit Condition ContourLineKit Control CullingKit CurveAttributeKit CutGeometryGatheringOptionsKit CuttingSectionAttributeKit CuttingSectionKit CylinderAttributeKit CylinderKit DebuggingKit Definition DistantLightKit DrawingAttributeKit EdgeAttributeKit EllipseKit EllipticalArcKit EventDispatcher EventHandler EventNotifier FontInfoState FontSearchResults FontSearchResultsIterator GlyphElement GlyphKit GridKit Hardcopy::File::ExportOptionsKit Hardcopy::GDI::ExportOptionsKit HiddenLineAttributeKit HighlightOptionsKit Image::ExportOptionsKit Image::ImportOptionsKit ImageKit InfiniteLineKit IONotifier Key KeyboardState KeyPath LightingAttributeKit LineAttributeKit LineKit LinePatternElement LinePatternKit LinePatternOptionsKit LinePatternParallelKit MarkerAttributeKit MarkerKit MaterialKit MaterialMappingKit MatrixKit MeshKit MouseState NURBSCurveKit NURBSSurfaceAttributeKit NURBSSurfaceKit OBJ::ImportOptionsKit OBJ::ImportResultsKit OffScreenWindowOptionsKit PerformanceKit PolygonKit PostProcessEffectsKit SearchOptionsKit SearchResults SearchResultsIterator SelectabilityKit SelectionControl SelectionItem SelectionOptionsKit SelectionResults SelectionResultsIterator Shader::ImportOptionsKit ShaderKit ShellKit ShellOptimizationOptionsKit ShellRelationOptionsKit ShellRelationResultsKit SphereAttributeKit SphereKit SpotlightKit Sprocket StandAloneWindowOptionsKit STL::ImportOptionsKit STL::ImportResultsKit Stream::ExportOptionsKit Stream::ImportOptionsKit Stream::ImportResultsKit SubwindowKit TextAttributeKit TextKit TextureOptionsKit TouchState TransformMaskKit TransparencyKit TreeContext TrimElement TrimKit UpdateNotifier UpdateOptionsKit VisibilityKit VisualEffectsKit WindowInfoKit World

Public Member Functions

virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
virtual Type ObjectType () const
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
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

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

virtual bool 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 STL::ImportResultsKit, STL::ImportOptionsKit, OBJ::ImportResultsKit, OBJ::ImportOptionsKit, Hardcopy::GDI::ExportOptionsKit, Hardcopy::File::ExportOptionsKit, Stream::ExportOptionsKit, Stream::ImportResultsKit, Stream::ImportOptionsKit, UpdateOptionsKit, HighlightOptionsKit, SelectionOptionsKit, SearchOptionsKit, CutGeometryGatheringOptionsKit, ShaderKit, Shader::ImportOptionsKit, ImageKit, Image::ImportOptionsKit, Image::ExportOptionsKit, TextureOptionsKit, LinePatternKit, LinePatternParallelKit, LinePatternOptionsKit, GlyphKit, ApplicationWindowOptionsKit, OffScreenWindowOptionsKit, StandAloneWindowOptionsKit, GridKit, PolygonKit, MeshKit, ShellKit, ShellRelationResultsKit, ShellRelationOptionsKit, ShellOptimizationOptionsKit, TextKit, EllipticalArcKit, EllipseKit, TrimKit, NURBSSurfaceKit, NURBSCurveKit, SpotlightKit, InfiniteLineKit, CuttingSectionKit, CircularWedgeKit, CircularArcKit, CircleKit, SphereKit, CylinderKit, DistantLightKit, MarkerKit, LineKit, AttributeLockKit, FontInfoState, WindowInfoKit, DebuggingKit, SubwindowKit, ContourLineKit, VisualEffectsKit, TransformMaskKit, PostProcessEffectsKit, DrawingAttributeKit, HiddenLineAttributeKit, PerformanceKit, NURBSSurfaceAttributeKit, MaterialKit, MaterialMappingKit, MatrixKit, CurveAttributeKit, EdgeAttributeKit, LineAttributeKit, TextAttributeKit, CuttingSectionAttributeKit, CylinderAttributeKit, LightingAttributeKit, SphereAttributeKit, MarkerAttributeKit, CullingKit, ColorInterpolationKit, TransparencyKit, SelectabilityKit, CameraKit, VisibilityKit, BoundingKit, Publish::ExportOptionsKit, Publish::TextFieldKit, Publish::SignatureFieldKit, Publish::DropDownListKit, Publish::ListBoxKit, Publish::RadioButtonKit, Publish::CheckBoxKit, Publish::ButtonKit, Publish::LinkKit, Publish::SlideTableKit, Publish::TableKit, Publish::ImageKit, Publish::TextKit, Exchange::TessellationOptionsKit, Publish::ViewKit, Exchange::ExportXMLOptionsKit, Exchange::ExportU3DOptionsKit, Publish::ArtworkKit, Exchange::ExportSTLOptionsKit, Exchange::ExportSTEPOptionsKit, Exchange::ExportPRCOptionsKit, Publish::AnnotationKit, Exchange::ExportParasolidOptionsKit, Exchange::ExportJTOptionsKit, Exchange::ExportIGESOptionsKit, Exchange::ExportACISOptionsKit, Parasolid::ExportOptionsKit, Parasolid::LineTessellationKit, Publish::PageKit, Exchange::ImportOptionsKit, Exchange::Configuration, Parasolid::FacetTessellationKit, Publish::DocumentKit, Parasolid::ImportOptionsKit, Sketchup::ImportOptionsKit, and Sketchup::ImportResultsKit.

intptr_t Object::GetClassID ( ) const

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

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

Object& 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 Object::Reset ( )
virtual

Resets this object to its initial, uninitialized state.

Reimplemented in EventHandler, SelectionResults, SelectionResultsIterator, FontSearchResults, FontSearchResultsIterator, SearchResults, and SearchResultsIterator.

Type 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: