HPS::TextureDefinition Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::TextureDefinition:

Collaboration diagram for HPS::TextureDefinition:

Public Member Functions
	TextureDefinition ()
	The default constructor creates an uninitialized TextureDefinition object. More...
	TextureDefinition (Definition const &in_that)
	This constructor creates a TextureDefinition object that shares the underlying smart-pointer of the source Definition. More...
	TextureDefinition (TextureDefinition const &in_that)
	The copy constructor creates an TextureDefinition object that shares the underlying smart-pointer of the source TextureDefinition. More...
TextureDefinition &	operator= (TextureDefinition const &in_that)
	Associate this TextureDefinition with the same underlying impl as the source TextureDefinition. More...
	TextureDefinition (TextureDefinition &&in_that)
	The move constructor creates a TextureDefinition by transferring the underlying impl of the rvalue reference to this TextureDefinition thereby avoiding a copy and allocation. More...
TextureDefinition &	operator= (TextureDefinition &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this TextureDefinition thereby avoiding a copy. More...
	~TextureDefinition ()
HPS::Type	ObjectType () const
void	SetSource (ImageDefinition const &in_source)
	Redefine the image for this TextureDefinition. More...
bool	ShowSource (ImageDefinition &out_source) const
	Show the image for this TextureDefinition. More...
bool	ShowSource (UTF8 &out_source) const
	Show the name of the source image for this TextureDefinition. More...
void	SetOptions (TextureOptionsKit const &in_options)
	Redefine the texture options for this TextureDefinition. More...
void	ShowOptions (TextureOptionsKit &out_options) const
	Show the texture options for this TextureDefinition. 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::TextureDefinition

Detailed Description

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

It is a handler to a texture defined within a portfolio.

Constructor & Destructor Documentation

TextureDefinition() [1/4]

HPS::TextureDefinition::TextureDefinition

(

)

The default constructor creates an uninitialized TextureDefinition object.

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

TextureDefinition() [2/4]

HPS::TextureDefinition::TextureDefinition

(

Definition const &

in_that

)

This constructor creates a TextureDefinition 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 a texture definition. Otherwise the copy will fail and the resulting TextureDefinition will be invalid.

Parameters

in_that

The source Definition to copy.

TextureDefinition() [3/4]

HPS::TextureDefinition::TextureDefinition

(

TextureDefinition const &

in_that

)

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

Parameters

in_that

The source TextureDefinition to copy.

TextureDefinition() [4/4]

HPS::TextureDefinition::TextureDefinition

(

TextureDefinition &&

in_that

)

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

Parameters

in_that

An rvalue reference to a TextureDefinition to take the impl from.

~TextureDefinition()

HPS::TextureDefinition::~TextureDefinition

(

)

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::TextureDefinition::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]

TextureDefinition& HPS::TextureDefinition::operator=

(

TextureDefinition const &

in_that

)

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

Parameters

in_that

The source TextureDefinition for the assignment.

Returns

A reference to this TextureDefinition.

operator=() [2/2]

TextureDefinition& HPS::TextureDefinition::operator=

(

TextureDefinition &&

in_that

)

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

Parameters

in_that

An rvalue reference to a TextureDefinition to take the impl from.

Returns

A reference to this TextureDefinition.

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.

SetOptions()

void HPS::TextureDefinition::SetOptions

(

TextureOptionsKit const &

in_options

)

Redefine the texture options for this TextureDefinition.

Parameters

in_options

The new texture options for this TextureDefinition.

SetSource()

void HPS::TextureDefinition::SetSource

(

ImageDefinition const &

in_source

)

Redefine the image for this TextureDefinition.

Parameters

in_source

The new image for this TextureDefinition.

ShowOptions()

void HPS::TextureDefinition::ShowOptions

(

TextureOptionsKit &

out_options

)

const

Show the texture options for this TextureDefinition.

Parameters

out_options

The texture options for this TextureDefinition.

ShowSource() [1/2]

bool HPS::TextureDefinition::ShowSource

(

ImageDefinition &

out_source

)

const

Show the image for this TextureDefinition.

Parameters

out_source

The image for this TextureDefinition.

Returns

true if an image definition was found in the same Portfolio as this TextureDefinition, false otherwise.

ShowSource() [2/2]

bool HPS::TextureDefinition::ShowSource

(

UTF8 &

out_source

)

const

Show the name of the source image for this TextureDefinition.

If the source image for this TextureDefinition resides in a separate portfolio, users can use this method to retrieve the name of the source image, and use KeyPath::ShowEffectiveImageDefinition with the image name to retrieve the image definition.

Parameters

out_source

The name of the source image for this TextureDefinition.

Returns

true if able to retrieve the name of the source image, false otherwise.

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::TextureDefinition::staticType = HPS::Type::TextureDefinition

static

---

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

• hps.h