HPS::ImageDefinition Class Reference

The ImageDefinition class is a smart pointer to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::ImageDefinition:

Collaboration diagram for HPS::ImageDefinition:

Public Member Functions
	ImageDefinition ()
	The default constructor creates an uninitialized ImageDefinition object. More...
	ImageDefinition (Definition const &in_that)
	This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition. More...
	ImageDefinition (ImageDefinition const &in_that)
	The copy constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source ImageDefinition. More...
ImageDefinition &	operator= (ImageDefinition const &in_that)
	Associate this ImageDefinition with the same underlying impl as the source ImageDefinition. More...
	ImageDefinition (ImageDefinition &&in_that)
	The move constructor creates an ImageDefinition by transferring the underlying impl of the rvalue reference to this ImageDefinition thereby avoiding a copy and allocation. More...
ImageDefinition &	operator= (ImageDefinition &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ImageDefinition thereby avoiding a copy. More...
	~ImageDefinition ()
HPS::Type	ObjectType () const
void	Set (ImageKit const &in_kit)
	Redefine the image for this ImageDefinition. More...
void	Show (ImageKit &out_kit) const
	Shows the image for this ImageDefinition. More...
void	Undefine ()
	Removes this definition from the owning portfolio. More...
PortfolioKey	Owner () const
	Get the portfolio that owns this Definition. More...
UTF8	Name () const
	Get the name given to this Definition when it was defined. More...
virtual void	Assign (Definition const &in_that)
	Associate this Definition with the same underlying impl as the source Definition. More...
bool	Equals (Definition const &in_that) const
	Check if the source Definition is equivalent to this Definition. More...
bool	operator== (Definition const &in_that) const
	Check if the source Definition is equivalent to this Definition. More...
bool	operator!= (Definition const &in_that) const
	Check if the source Definition is not equivalent to this Definition. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
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::ImageDefinition

Detailed Description

The ImageDefinition class is a smart pointer to a database object.

It is a handle to an image defined within a portolfio.

Constructor & Destructor Documentation

ImageDefinition() [1/4]

HPS::ImageDefinition::ImageDefinition

(

)

The default constructor creates an uninitialized ImageDefinition object.

The Type() function will return Type::None.

ImageDefinition() [2/4]

HPS::ImageDefinition::ImageDefinition

(

Definition const &

in_that

)

This constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source Definition.

The copy will only be successful if the source definition is really an upcast of an image definition. Otherwise the copy will fail and the resulting ImageDefinition will be invalid.

Parameters

in_that

The source Definition to copy.

ImageDefinition() [3/4]

HPS::ImageDefinition::ImageDefinition

(

ImageDefinition const &

in_that

)

The copy constructor creates an ImageDefinition object that shares the underlying smart-pointer of the source ImageDefinition.

Parameters

in_that

The source ImageDefinition to copy.

ImageDefinition() [4/4]

HPS::ImageDefinition::ImageDefinition

(

ImageDefinition &&

in_that

)

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

Parameters

in_that

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

~ImageDefinition()

HPS::ImageDefinition::~ImageDefinition

(

)

Member Function Documentation

Assign()

virtual void HPS::Definition::Assign ( Definition const &  in_that )

virtualinherited

Associate this Definition with the same underlying impl as the source Definition.

Parameters

in_that

The source Definition for the assignment.

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.

Equals()

bool HPS::Definition::Equals ( Definition const &  in_that ) const

inherited

Check if the source Definition is equivalent to this Definition.

Parameters

in_that

The source Definition to compare to this Definition.

Returns

true if the objects are equivalent, false otherwise.

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_mask

The Type mask to check against this Object.

Returns

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

Name()

UTF8 HPS::Definition::Name ( ) const

inherited

Get the name given to this Definition when it was defined.

Returns

UTF8-encoded name of this Definition.

ObjectType()

HPS::Type HPS::ImageDefinition::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Definition.

operator!=()

bool HPS::Definition::operator!= ( Definition const &  in_that ) const

inherited

Check if the source Definition is not equivalent to this Definition.

Parameters

in_that

The source Definition to compare to this Definition.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

ImageDefinition& HPS::ImageDefinition::operator=

(

ImageDefinition const &

in_that

)

Associate this ImageDefinition with the same underlying impl as the source ImageDefinition.

Parameters

in_that

The source ImageDefinition for the assignment.

Returns

A reference to this ImageDefinition.

operator=() [2/2]

ImageDefinition& HPS::ImageDefinition::operator=

(

ImageDefinition &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this ImageDefinition.

operator==()

bool HPS::Definition::operator== ( Definition const &  in_that ) const

inherited

Check if the source Definition is equivalent to this Definition.

Parameters

in_that

The source Definition to compare to this Definition.

Returns

true if the objects are equivalent, false otherwise.

Owner()

PortfolioKey HPS::Definition::Owner ( ) const

inherited

Get the portfolio that owns this Definition.

Returns

The portfolio that owns this Definition.

Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

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

Set()

void HPS::ImageDefinition::Set

(

ImageKit const &

in_kit

)

Redefine the image for this ImageDefinition.

Parameters

in_kit

The new image for this ImageDefinition.

Show()

void HPS::ImageDefinition::Show

(

ImageKit &

out_kit

)

const

Shows the image for this ImageDefinition.

Parameters

out_kit

The image for this ImageDefinition.

Type()

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

virtualinherited

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

Undefine()

void HPS::Definition::Undefine ( )

inherited

Removes this definition from the owning portfolio.

Member Data Documentation

staticType

const HPS::Type HPS::ImageDefinition::staticType = HPS::Type::ImageDefinition

static

---

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

• hps.h