HPS::PortfolioKey Class Reference

#include <hps.h>

Inheritance diagram for HPS::PortfolioKey:

Public Member Functions
CubeMapDefinition	DefineCubeMap (char const *in_name, ImageDefinition const &in_negative_z, ImageDefinition const &in_positive_z, ImageDefinition const &in_negative_x, ImageDefinition const &in_positive_x, ImageDefinition const &in_negative_y, ImageDefinition const &in_positive_y)
CubeMapDefinition	DefineCubeMap (char const *in_name, ImageDefinition const &in_negative_z, ImageDefinition const &in_positive_z, ImageDefinition const &in_negative_x, ImageDefinition const &in_positive_x, ImageDefinition const &in_negative_y, ImageDefinition const &in_positive_y, TextureOptionsKit const &in_options)
GlyphDefinition	DefineGlyph (char const *in_name, GlyphKit const &in_source)
ImageDefinition	DefineImage (char const *in_name, ImageKit const &in_source)
LinePatternDefinition	DefineLinePattern (char const *in_name, LinePatternKit const &in_source)
MaterialPaletteDefinition	DefineMaterialPalette (char const *in_name, MaterialKitArray const &in_source)
MaterialPaletteDefinition	DefineMaterialPalette (char const *in_name, size_t in_count, MaterialKit const in_source [])
NamedStyleDefinition	DefineNamedStyle (char const *in_name, SegmentKey const &in_style_source)
ShaderDefinition	DefineShader (char const *in_name, ShaderKit const &in_source)
ShapeDefinition	DefineShape (char const *in_name, ShapeKit const &in_source)
TextureDefinition	DefineTexture (char const *in_name, ImageDefinition const &in_source)
TextureDefinition	DefineTexture (char const *in_name, ImageDefinition const &in_source, TextureOptionsKit const &in_options)
size_t	GetCubeMapDefinitionCount () const
size_t	GetDefinitionCount () const
size_t	GetGlyphDefinitionCount () const
size_t	GetImageDefinitionCount () const
size_t	GetLinePatternDefinitionCount () const
size_t	GetMaterialPaletteDefinitionCount () const
size_t	GetNamedStyleDefinitionCount () const
size_t	GetShaderDefinitionCount () const
size_t	GetShapeDefinitionCount () const
size_t	GetTextureDefinitionCount () const
PortfolioKey &	ImportAllCubeMaps (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllGlyphs (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllImages (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllLinePatterns (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllMaterialPalettes (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllNamedStyles (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllShaders (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllShapes (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
PortfolioKey &	ImportAllTextures (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
CubeMapDefinition	ImportCubeMap (CubeMapDefinition const &in_definition)
GlyphDefinition	ImportGlyph (GlyphDefinition const &in_definition)
ImageDefinition	ImportImage (ImageDefinition const &in_definition)
LinePatternDefinition	ImportLinePattern (LinePatternDefinition const &in_definition)
MaterialPaletteDefinition	ImportMaterialPalette (MaterialPaletteDefinition const &in_definition)
NamedStyleDefinition	ImportNamedStyle (NamedStyleDefinition const &in_definition)
PortfolioKey &	ImportPortfolio (PortfolioKey const &in_portfolio, bool in_replace_existing=true)
ShaderDefinition	ImportShader (ShaderDefinition const &in_definition)
ShapeDefinition	ImportShape (ShapeDefinition const &in_definition)
TextureDefinition	ImportTexture (TextureDefinition const &in_definition)
HPS::Type	ObjectType () const
PortfolioKey &	operator= (PortfolioKey const &in_that)
PortfolioKey &	operator= (PortfolioKey &&in_that)
	PortfolioKey ()
	PortfolioKey (Key const &in_that)
	PortfolioKey (PortfolioKey const &in_that)
	PortfolioKey (PortfolioKey &&in_that)
bool	ShowAllCubeMapDefinitions (CubeMapDefinitionArray &out_definitions) const
bool	ShowAllGlyphDefinitions (GlyphDefinitionArray &out_definitions) const
bool	ShowAllImageDefinitions (ImageDefinitionArray &out_definitions) const
bool	ShowAllLinePatternDefinitions (LinePatternDefinitionArray &out_definitions) const
bool	ShowAllMaterialPaletteDefinitions (MaterialPaletteDefinitionArray &out_definitions) const
bool	ShowAllNamedStyleDefinitions (NamedStyleDefinitionArray &out_definitions) const
bool	ShowAllShaderDefinitions (ShaderDefinitionArray &out_definitions) const
bool	ShowAllShapeDefinitions (ShapeDefinitionArray &out_definitions) const
bool	ShowAllTextureDefinitions (TextureDefinitionArray &out_definitions) const
bool	ShowCubeMapDefinition (char const *in_name) const
bool	ShowCubeMapDefinition (char const *in_name, CubeMapDefinition &out_found) const
bool	ShowGlyphDefinition (char const *in_name) const
bool	ShowGlyphDefinition (char const *in_name, GlyphDefinition &out_found) const
bool	ShowImageDefinition (char const *in_name) const
bool	ShowImageDefinition (char const *in_name, ImageDefinition &out_found) const
bool	ShowLinePatternDefinition (char const *in_name) const
bool	ShowLinePatternDefinition (char const *in_name, LinePatternDefinition &out_found) const
bool	ShowMaterialPaletteDefinition (char const *in_name) const
bool	ShowMaterialPaletteDefinition (char const *in_name, MaterialPaletteDefinition &out_found) const
bool	ShowNamedStyleDefinition (char const *in_name) const
bool	ShowNamedStyleDefinition (char const *in_name, NamedStyleDefinition &out_found) const
bool	ShowShaderDefinition (char const *in_name) const
bool	ShowShaderDefinition (char const *in_name, ShaderDefinition &out_found) const
bool	ShowShapeDefinition (char const *in_name) const
bool	ShowShapeDefinition (char const *in_name, ShapeDefinition &out_found) const
bool	ShowTextureDefinition (char const *in_name) const
bool	ShowTextureDefinition (char const *in_name, TextureDefinition &out_found) const
PortfolioKey &	UndefineCubeMap (char const *in_name)
PortfolioKey &	UndefineGlyph (char const *in_name)
PortfolioKey &	UndefineImage (char const *in_name)
PortfolioKey &	UndefineLinePattern (char const *in_name)
PortfolioKey &	UndefineMaterialPalette (char const *in_name)
PortfolioKey &	UndefineNamedStyle (char const *in_name)
PortfolioKey &	UndefineShader (char const *in_name)
PortfolioKey &	UndefineShape (char const *in_name)
PortfolioKey &	UndefineTexture (char const *in_name)
Public Member Functions inherited from HPS::Key
virtual void	Assign (Key const &in_that)
Key	CopyTo (SegmentKey const &in_destination) const
void	Delete ()
bool	Equals (Key const &in_that) const
size_t	GetHash () const
bool	HasOwner () const
	Key ()
	Key (Key const &in_that)
	Key (Control const &in_control)
	Key (Key &&in_that)
void	MoveTo (SegmentKey const &in_new_owner)
bool	operator!= (Key const &in_that) const
Key &	operator= (Key &&in_that)
Key &	operator= (Key const &in_that)
bool	operator== (Key const &in_that) const
SegmentKey	Owner () const
SegmentKey	Up () const
virtual	~Key ()
Public Member Functions inherited from HPS::Object
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)
Object &	operator= (Object const &other_object)
Object &	operator= (Object &&in_that)
virtual void	Reset ()
virtual HPS::Type	Type () const

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::PortfolioKey
Static Public Attributes inherited from HPS::Key
static const HPS::Type	staticType = HPS::Type::Key
Static Public Attributes inherited from HPS::Object
static const HPS::Type	staticType = HPS::Type::None

Additional Inherited Members
Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t	ClassID ()

Detailed Description

The PortfolioKey class is a smart pointer to a database object. Portfolios are special objects that can only contain definitions. A segment can use a portfolio to gain access to the definitions it contains.

Constructor & Destructor Documentation

PortfolioKey() [1/4]

HPS::PortfolioKey::PortfolioKey

(

)

The default constructor creates an uninitialized PortfolioKey object. The Type() function will return Type::None.

PortfolioKey() [2/4]

HPS::PortfolioKey::PortfolioKey ( Key const &  in_that )

explicit

This constructor creates a PortfolioKey object that shares the underlying smart-pointer of the source Key. The copy will only be successful if the source key is really an upcast of an offscreen window. Otherwise the copy will fail and the resulting PortfolioKey will be invalid.

Parameters

in_key

The source Key to copy.

PortfolioKey() [3/4]

HPS::PortfolioKey::PortfolioKey

(

PortfolioKey const &

in_that

)

The copy constructor creates a PortfolioKey object that shares the underlying smart-pointer of the source PortfolioKey.

Parameters

in_that

The source PortfolioKey to copy.

PortfolioKey() [4/4]

HPS::PortfolioKey::PortfolioKey

(

PortfolioKey &&

in_that

)

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

Parameters

in_that

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

Member Function Documentation

DefineCubeMap() [1/2]

CubeMapDefinition HPS::PortfolioKey::DefineCubeMap	(	char const *	in_name,
		ImageDefinition const &	in_negative_z,
		ImageDefinition const &	in_positive_z,
		ImageDefinition const &	in_negative_x,
		ImageDefinition const &	in_positive_x,
		ImageDefinition const &	in_negative_y,
		ImageDefinition const &	in_positive_y
	)

Creates a new cube map definition in this portfolio with the specified name, based on the specified images and with the default texture options. This will replace any existing cube map of the same name within this portfolio. The image sources must be defined within the same portfolio, if they are not, the returned definition will be invalid.

Parameters

in_name	UTF8-encoded name for the new cube map definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_negative_z	The source image for the negative z-axis for the new cube map definition.
in_positive_z	The source image for the positive z-axis for the new cube map definition.
in_negative_x	The source image for the negative x-axis for the new cube map definition.
in_positive_x	The source image for the positive x-axis for the new cube map definition.
in_negative_y	The source image for the negative y-axis for the new cube map definition.
in_positive_y	The source image for the positive y-axis for the new cube map definition.

Returns

A newly created CubeMapDefinition.

DefineCubeMap() [2/2]

CubeMapDefinition HPS::PortfolioKey::DefineCubeMap	(	char const *	in_name,
		ImageDefinition const &	in_negative_z,
		ImageDefinition const &	in_positive_z,
		ImageDefinition const &	in_negative_x,
		ImageDefinition const &	in_positive_x,
		ImageDefinition const &	in_negative_y,
		ImageDefinition const &	in_positive_y,
		TextureOptionsKit const &	in_options
	)

Creates a new cube map definition in this portfolio with the specified name, based on the specified images and with the specified texture options. This will replace any existing cube map of the same name within this portfolio. The image sources must be defined within the same portfolio, if they are not, the returned definition will be invalid.

Parameters

in_name	UTF8-encoded name for the new cube map definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_negative_z	The source image for the negative z-axis for the new cube map definition.
in_positive_z	The source image for the positive z-axis for the new cube map definition.
in_negative_x	The source image for the negative x-axis for the new cube map definition.
in_positive_x	The source image for the positive x-axis for the new cube map definition.
in_negative_y	The source image for the negative y-axis for the new cube map definition.
in_positive_y	The source image for the positive y-axis for the new cube map definition.
in_options	The texture options for the new cube map definition.

Returns

A newly created CubeMapDefinition.

DefineGlyph()

GlyphDefinition HPS::PortfolioKey::DefineGlyph	(	char const *	in_name,
		GlyphKit const &	in_source
	)

Creates a new glyph definition in this portfolio with the specified name using the source GlyphKit. This will replace any existing glyph of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new glyph definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source GlyphKit for the new glyph definition.

Returns

A newly created GlyphDefinition.

DefineImage()

ImageDefinition HPS::PortfolioKey::DefineImage	(	char const *	in_name,
		ImageKit const &	in_source
	)

Creates a new image definition in this portfolio with the specified name from the source ImageKit. This will replace any existing image of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new image definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source ImageKit for the new image definition.

Returns

A newly created ImageDefinition.

DefineLinePattern()

LinePatternDefinition HPS::PortfolioKey::DefineLinePattern	(	char const *	in_name,
		LinePatternKit const &	in_source
	)

Creates a new line pattern definition in this portfolio with the specified name using the source LinePatternKit. This will replace any existing line pattern of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new line pattern definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source LinePatternKit for the new line pattern definition.

Returns

A newly created LinePatternDefinition.

DefineMaterialPalette() [1/2]

MaterialPaletteDefinition HPS::PortfolioKey::DefineMaterialPalette	(	char const *	in_name,
		MaterialKitArray const &	in_source
	)

Creates a new material palette definition in this portfolio with the specified name using the source MaterialKit array. This will replace any existing material palette of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new material palette definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source MaterialKit array for the new material palette definition.

Returns

A newly created MaterialPaletteDefinition.

DefineMaterialPalette() [2/2]

MaterialPaletteDefinition HPS::PortfolioKey::DefineMaterialPalette	(	char const *	in_name,
		size_t	in_count,
		MaterialKit const	in_source[]
	)

Creates a new material palette definition in this portfolio with the specified name using the source MaterialKit array. This will replace any existing material palette of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new material palette definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_count	Size of the following array.
in_source	The source MaterialKit array for the new material palette definition.

Returns

A newly created MaterialPaletteDefinition.

DefineNamedStyle()

NamedStyleDefinition HPS::PortfolioKey::DefineNamedStyle	(	char const *	in_name,
		SegmentKey const &	in_style_source
	)

Creates a new named style definition in this portfolio with the specified name using the source SegmentKey. This will replace any existing named style of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new named style definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_style_source	The source SegmentKey for the new named style definition.

Returns

A newly created NamedStyleDefinition.

DefineShader()

ShaderDefinition HPS::PortfolioKey::DefineShader	(	char const *	in_name,
		ShaderKit const &	in_source
	)

Internal use only - customers should not use. Creates a new shader definition in this portfolio with the specified name using the source ShaderKit. This will replace any existing shader of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new shader definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source ShaderKit for the new shader definition.

Returns

A newly created ShaderDefinition.

DefineShape()

ShapeDefinition HPS::PortfolioKey::DefineShape	(	char const *	in_name,
		ShapeKit const &	in_source
	)

Creates a new sjape definition in this portfolio with the specified name using the source ShapeKit. This will replace any existing shape of the same name within this portfolio.

Parameters

in_name	UTF8-encoded name for the new shape definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source ShapeKit for the new shape definition.

Returns

A newly created ShapeDefinition.

DefineTexture() [1/2]

TextureDefinition HPS::PortfolioKey::DefineTexture	(	char const *	in_name,
		ImageDefinition const &	in_source
	)

Creates a new texture definition in this portfolio with the specified name, based on the specified image and with the default texture options. This will replace any existing texture of the same name within this portfolio. The image source must be defined within the same portfolio, if it is not, the returned definition will be invalid.

Parameters

in_name	UTF8-encoded name for the new texture definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source image for the new texture definition.

Returns

A newly created TextureDefinition.

DefineTexture() [2/2]

TextureDefinition HPS::PortfolioKey::DefineTexture	(	char const *	in_name,
		ImageDefinition const &	in_source,
		TextureOptionsKit const &	in_options
	)

Creates a new texture definition in this portfolio with the specified name, based on the specified image and with the specified texture options. This will replace any existing texture of the same name within this portfolio. The image source must be defined within the same portfolio, if it is not, the returned definition will be invalid.

Parameters

in_name	UTF8-encoded name for the new texture definition. If null_ptr or empty string is used for this parameter, a nameless definition will be created.
in_source	The source image for the new texture definition.
in_options	The texture options for the new texture definition.

Returns

A newly created TextureDefinition.

GetCubeMapDefinitionCount()

size_t HPS::PortfolioKey::GetCubeMapDefinitionCount

(

)

const

Returns

The number of cube map definitions in this portfolio.

GetDefinitionCount()

size_t HPS::PortfolioKey::GetDefinitionCount

(

)

const

Returns

The number of definitions in this portfolio.

GetGlyphDefinitionCount()

size_t HPS::PortfolioKey::GetGlyphDefinitionCount

(

)

const

Returns

The number of glyph definitions in this portfolio.

GetImageDefinitionCount()

size_t HPS::PortfolioKey::GetImageDefinitionCount

(

)

const

Returns

The number of image definitions in this portfolio.

GetLinePatternDefinitionCount()

size_t HPS::PortfolioKey::GetLinePatternDefinitionCount

(

)

const

Returns

The number of line pattern definitions in this portfolio.

GetMaterialPaletteDefinitionCount()

size_t HPS::PortfolioKey::GetMaterialPaletteDefinitionCount

(

)

const

Returns

The number of material palette definitions in this portfolio.

GetNamedStyleDefinitionCount()

size_t HPS::PortfolioKey::GetNamedStyleDefinitionCount

(

)

const

Returns

The number of named style definitions in this portfolio.

GetShaderDefinitionCount()

size_t HPS::PortfolioKey::GetShaderDefinitionCount

(

)

const

Internal use only - customers should not use.

Returns

The number of shader definitions in this portfolio.

GetShapeDefinitionCount()

size_t HPS::PortfolioKey::GetShapeDefinitionCount

(

)

const

Returns

The number of shape definitions in this portfolio.

GetTextureDefinitionCount()

size_t HPS::PortfolioKey::GetTextureDefinitionCount

(

)

const

Returns

The number of texture definitions in this portfolio.

ImportAllCubeMaps()

PortfolioKey& HPS::PortfolioKey::ImportAllCubeMaps	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all cube map definitions from the specified portfolio into this portfolio. By default, existing cube map definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the cube map definitions from.
in_replace_existing	Whether to replace existing cube map definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllGlyphs()

PortfolioKey& HPS::PortfolioKey::ImportAllGlyphs	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all glyph definitions from the specified portfolio into this portfolio. By default, existing glyph definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the glyph definitions from.
in_replace_existing	Whether to replace existing glyph definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllImages()

PortfolioKey& HPS::PortfolioKey::ImportAllImages	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all image definitions from the specified portfolio into this portfolio. By default, existing image definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the image definitions from.
in_replace_existing	Whether to replace existing image definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllLinePatterns()

PortfolioKey& HPS::PortfolioKey::ImportAllLinePatterns	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all line pattern definitions from the specified portfolio into this portfolio. By default, existing line pattern definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the line pattern definitions from.
in_replace_existing	Whether to replace existing line pattern definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllMaterialPalettes()

PortfolioKey& HPS::PortfolioKey::ImportAllMaterialPalettes	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all material palette definitions from the specified portfolio into this portfolio. By default, existing material palette definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the material palette definitions from.
in_replace_existing	Whether to replace existing material palette definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllNamedStyles()

PortfolioKey& HPS::PortfolioKey::ImportAllNamedStyles	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all named style definitions from the specified portfolio into this portfolio. By default, existing named style definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the named style definitions from.
in_replace_existing	Whether to replace existing named style definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllShaders()

PortfolioKey& HPS::PortfolioKey::ImportAllShaders	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Internal use only - customers should not use. Copy all shader definitions from the specified portfolio into this portfolio. By default, existing shader definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the shader definitions from.
in_replace_existing	Whether to replace existing shader definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllShapes()

PortfolioKey& HPS::PortfolioKey::ImportAllShapes	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all shape definitions from the specified portfolio into this portfolio. By default, existing shape definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the shape definitions from.
in_replace_existing	Whether to replace existing shape definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportAllTextures()

PortfolioKey& HPS::PortfolioKey::ImportAllTextures	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all texture definitions from the specified portfolio into this portfolio. By default, existing texture definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the texture definitions from.
in_replace_existing	Whether to replace existing texture definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportCubeMap()

CubeMapDefinition HPS::PortfolioKey::ImportCubeMap

(

CubeMapDefinition const &

in_definition

)

Copy the specified cube map definition into this portfolio. This will replace an existing cube map definition of the same name.

Parameters

in_definition

The source cube map definition to copy into this portfolio.

Returns

A newly created CubeMapDefinition.

ImportGlyph()

GlyphDefinition HPS::PortfolioKey::ImportGlyph

(

GlyphDefinition const &

in_definition

)

Copy the specified glyph definition into this portfolio. This will replace an existing glyph definition of the same name.

Parameters

in_definition

The source glyph definition to copy into this portfolio.

Returns

A newly created GlyphDefinition.

ImportImage()

ImageDefinition HPS::PortfolioKey::ImportImage

(

ImageDefinition const &

in_definition

)

Copy the specified image definition into this portfolio. This will replace an existing image definition of the same name.

Parameters

in_definition

The source image definition to copy into this portfolio.

Returns

A newly created ImageDefinition.

ImportLinePattern()

LinePatternDefinition HPS::PortfolioKey::ImportLinePattern

(

LinePatternDefinition const &

in_definition

)

Copy the specified line pattern definition into this portfolio. This will replace an existing line pattern definition of the same name.

Parameters

in_definition

The source line pattern definition to copy into this portfolio.

Returns

A newly created LinePatternDefinition.

ImportMaterialPalette()

MaterialPaletteDefinition HPS::PortfolioKey::ImportMaterialPalette

(

MaterialPaletteDefinition const &

in_definition

)

Copy the specified material palette definition into this portfolio. This will replace an existing material palette definition of the same name.

Parameters

in_definition

The source material palette definition to copy into this portfolio.

Returns

A newly created MaterialPaletteDefinition.

ImportNamedStyle()

NamedStyleDefinition HPS::PortfolioKey::ImportNamedStyle

(

NamedStyleDefinition const &

in_definition

)

Copy the specified named style definition into this portfolio. This will replace an existing named style definition of the same name.

Parameters

in_definition

The source named style definition to copy into this portfolio.

Returns

A newly created NamedStyleDefinition.

ImportPortfolio()

PortfolioKey& HPS::PortfolioKey::ImportPortfolio	(	PortfolioKey const &	in_portfolio,
		bool	in_replace_existing = true
	)

Copy all definitions from the specified portfolio into this portfolio. By default, existing definitions of the same name within this portfolio will be replaced, unless otherwise specified.

Parameters

in_portfolio	The source portfolio to copy the definitions from.
in_replace_existing	Whether to replace existing definitions of the same name. Defaults to true.

Returns

A reference to this PortfolioKey.

ImportShader()

ShaderDefinition HPS::PortfolioKey::ImportShader

(

ShaderDefinition const &

in_definition

)

Internal use only - customers should not use. Copy the specified shader definition into this portfolio. This will replace an existing shader definition of the same name.

Parameters

in_definition

The source shader definition to copy into this portfolio.

Returns

A newly created ShaderDefinition.

ImportShape()

ShapeDefinition HPS::PortfolioKey::ImportShape

(

ShapeDefinition const &

in_definition

)

Copy the specified shape definition into this portfolio. This will replace an existing shape definition of the same name.

Parameters

in_definition

The source shape definition to copy into this portfolio.

Returns

A newly created ShapeDefinition.

ImportTexture()

TextureDefinition HPS::PortfolioKey::ImportTexture

(

TextureDefinition const &

in_definition

)

Copy the specified texture definition into this portfolio. This will replace an existing texture definition of the same name.

Parameters

in_definition

The source texture definition to copy into this portfolio.

Returns

A newly created TextureDefinition.

ObjectType()

HPS::Type HPS::PortfolioKey::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 from HPS::Key.

operator=() [1/2]

PortfolioKey& HPS::PortfolioKey::operator=

(

PortfolioKey const &

in_that

)

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

Parameters

in_that

The source PortfolioKey for the assignment.

Returns

A reference to this PortfolioKey.

operator=() [2/2]

PortfolioKey& HPS::PortfolioKey::operator=

(

PortfolioKey &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this PortfolioKey.

ShowAllCubeMapDefinitions()

bool HPS::PortfolioKey::ShowAllCubeMapDefinitions

(

CubeMapDefinitionArray &

out_definitions

)

const

Shows all cube maps defined within this portfolio.

Parameters

out_definitions

The array of cube maps defined within this portfolio.

Returns

true if any cube maps are defined in this portfolio, false otherwise.

ShowAllGlyphDefinitions()

bool HPS::PortfolioKey::ShowAllGlyphDefinitions

(

GlyphDefinitionArray &

out_definitions

)

const

Shows all glyphs defined within this portfolio.

Parameters

out_definitions

The array of glyphs defined within this portfolio.

Returns

true if any glyphs are defined in this portfolio, false otherwise.

ShowAllImageDefinitions()

bool HPS::PortfolioKey::ShowAllImageDefinitions

(

ImageDefinitionArray &

out_definitions

)

const

Shows all images defined within this portfolio.

Parameters

out_definitions

The array of images defined within this portfolio.

Returns

true if any images are defined in this portfolio, false otherwise.

ShowAllLinePatternDefinitions()

bool HPS::PortfolioKey::ShowAllLinePatternDefinitions

(

LinePatternDefinitionArray &

out_definitions

)

const

Shows all line patterns defined within this portfolio.

Parameters

out_definitions

The array of line patterns defined within this portfolio.

Returns

true if any line patterns are defined in this portfolio, false otherwise.

ShowAllMaterialPaletteDefinitions()

bool HPS::PortfolioKey::ShowAllMaterialPaletteDefinitions

(

MaterialPaletteDefinitionArray &

out_definitions

)

const

Shows all material palettes defined within this portfolio.

Parameters

out_definitions

The array of material palettes defined within this portfolio.

Returns

true if any material palettes are defined in this portfolio, false otherwise.

ShowAllNamedStyleDefinitions()

bool HPS::PortfolioKey::ShowAllNamedStyleDefinitions

(

NamedStyleDefinitionArray &

out_definitions

)

const

Shows all named styles defined within this portfolio.

Parameters

out_definitions

The array of named styles defined within this portfolio.

Returns

true if any named styles are defined in this portfolio, false otherwise.

ShowAllShaderDefinitions()

bool HPS::PortfolioKey::ShowAllShaderDefinitions

(

ShaderDefinitionArray &

out_definitions

)

const

Internal use only - customers should not use. Shows all shaders defined within this portfolio.

Parameters

out_definitions

The array of shaders defined within this portfolio.

Returns

true if any shaders are defined in this portfolio, false otherwise.

ShowAllShapeDefinitions()

bool HPS::PortfolioKey::ShowAllShapeDefinitions

(

ShapeDefinitionArray &

out_definitions

)

const

Shows all shapes defined within this portfolio.

Parameters

out_definitions

The array of shapes defined within this portfolio.

Returns

true if any shapes are defined in this portfolio, false otherwise.

ShowAllTextureDefinitions()

bool HPS::PortfolioKey::ShowAllTextureDefinitions

(

TextureDefinitionArray &

out_definitions

)

const

Shows all textures defined within this portfolio.

Parameters

out_definitions

The array of textures defined within this portfolio.

Returns

true if any textures are defined in this portfolio, false otherwise.

ShowCubeMapDefinition() [1/2]

bool HPS::PortfolioKey::ShowCubeMapDefinition

(

char const *

in_name

)

const

Finds the cube map definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the cube map to find in this portfolio.

Returns

true if a cube map definition with the specified name was found, false otherwise.

ShowCubeMapDefinition() [2/2]

bool HPS::PortfolioKey::ShowCubeMapDefinition	(	char const *	in_name,
		CubeMapDefinition &	out_found
	)		const

Finds the cube map definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the cube map to find in this portfolio.
out_found	The cube map definition from this portfolio with the specified name.

Returns

true if a cube map definition with the specified name was found, false otherwise.

ShowGlyphDefinition() [1/2]

bool HPS::PortfolioKey::ShowGlyphDefinition

(

char const *

in_name

)

const

Finds the glyph definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the glyph to find in this portfolio.

Returns

true if a glyph definition with the specified name was found, false otherwise.

ShowGlyphDefinition() [2/2]

bool HPS::PortfolioKey::ShowGlyphDefinition	(	char const *	in_name,
		GlyphDefinition &	out_found
	)		const

Finds the glyph definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the glyph to find in this portfolio.
out_found	The glyph definition from this portfolio with the specified name.

Returns

true if a glyph definition with the specified name was found, false otherwise.

ShowImageDefinition() [1/2]

bool HPS::PortfolioKey::ShowImageDefinition

(

char const *

in_name

)

const

Finds the image definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the image to find in this portfolio.

Returns

true if an image definition with the specified name was found, false otherwise.

ShowImageDefinition() [2/2]

bool HPS::PortfolioKey::ShowImageDefinition	(	char const *	in_name,
		ImageDefinition &	out_found
	)		const

Finds the image definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the image to find in this portfolio.
out_found	The image definition from this portfolio with the specified name.

Returns

true if an image definition with the specified name was found, false otherwise.

ShowLinePatternDefinition() [1/2]

bool HPS::PortfolioKey::ShowLinePatternDefinition

(

char const *

in_name

)

const

Finds the line pattern definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the line pattern to find in this portfolio.

Returns

true if a line pattern definition with the specified name was found, false otherwise.

ShowLinePatternDefinition() [2/2]

bool HPS::PortfolioKey::ShowLinePatternDefinition	(	char const *	in_name,
		LinePatternDefinition &	out_found
	)		const

Finds the line pattern definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the line pattern to find in this portfolio.
out_found	The line pattern definition from this portfolio with the specified name.

Returns

true if a line pattern definition with the specified name was found, false otherwise.

ShowMaterialPaletteDefinition() [1/2]

bool HPS::PortfolioKey::ShowMaterialPaletteDefinition

(

char const *

in_name

)

const

Finds the material palette definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the material palette to find in this portfolio.

Returns

true if a material palette definition with the specified name was found, false otherwise.

ShowMaterialPaletteDefinition() [2/2]

bool HPS::PortfolioKey::ShowMaterialPaletteDefinition	(	char const *	in_name,
		MaterialPaletteDefinition &	out_found
	)		const

Finds the material palette definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the material palette to find in this portfolio.
out_found	The material palette definition from this portfolio with the specified name.

Returns

true if a material palette definition with the specified name was found, false otherwise.

ShowNamedStyleDefinition() [1/2]

bool HPS::PortfolioKey::ShowNamedStyleDefinition

(

char const *

in_name

)

const

Finds the named style definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the named style to find in this portfolio.

Returns

true if a named style definition with the specified name was found, false otherwise.

ShowNamedStyleDefinition() [2/2]

bool HPS::PortfolioKey::ShowNamedStyleDefinition	(	char const *	in_name,
		NamedStyleDefinition &	out_found
	)		const

Finds the named style definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the named style to find in this portfolio.
out_found	The named style definition from this portfolio with the specified name.

Returns

true if a named style definition with the specified name was found, false otherwise.

ShowShaderDefinition() [1/2]

bool HPS::PortfolioKey::ShowShaderDefinition

(

char const *

in_name

)

const

Internal use only - customers should not use. Finds the shader definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the shader to find in this portfolio.

Returns

true if a shader definition with the specified name was found, false otherwise.

ShowShaderDefinition() [2/2]

bool HPS::PortfolioKey::ShowShaderDefinition	(	char const *	in_name,
		ShaderDefinition &	out_found
	)		const

Internal use only - customers should not use. Finds the shader definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the shader to find in this portfolio.
out_found	The shader definition from this portfolio with the specified name.

Returns

true if a shader definition with the specified name was found, false otherwise.

ShowShapeDefinition() [1/2]

bool HPS::PortfolioKey::ShowShapeDefinition

(

char const *

in_name

)

const

Finds the shape definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the shape to find in this portfolio.

Returns

true if a shape definition with the specified name was found, false otherwise.

ShowShapeDefinition() [2/2]

bool HPS::PortfolioKey::ShowShapeDefinition	(	char const *	in_name,
		ShapeDefinition &	out_found
	)		const

Finds the shape definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the shape to find in this portfolio.
out_found	The shape definition from this portfolio with the specified name.

Returns

true if a shape definition with the specified name was found, false otherwise.

ShowTextureDefinition() [1/2]

bool HPS::PortfolioKey::ShowTextureDefinition

(

char const *

in_name

)

const

Finds the texture definition with the specified name in this portfolio.

Parameters

in_name

UTF8-encoded name of the texture to find in this portfolio.

Returns

true if a texture definition with the specified name was found, false otherwise.

ShowTextureDefinition() [2/2]

bool HPS::PortfolioKey::ShowTextureDefinition	(	char const *	in_name,
		TextureDefinition &	out_found
	)		const

Finds the texture definition with the specified name in this portfolio.

Parameters

in_name	UTF8-encoded name of the texture to find in this portfolio.
out_found	The texture definition from this portfolio with the specified name.

Returns

true if a texture definition with the specified name was found, false otherwise.

UndefineCubeMap()

PortfolioKey& HPS::PortfolioKey::UndefineCubeMap

(

char const *

in_name

)

Remove the cube map definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the cube map to remove.

Returns

A reference to this PortfolioKey.

UndefineGlyph()

PortfolioKey& HPS::PortfolioKey::UndefineGlyph

(

char const *

in_name

)

Remove the glyph definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the glyph to remove.

Returns

A reference to this PortfolioKey.

UndefineImage()

PortfolioKey& HPS::PortfolioKey::UndefineImage

(

char const *

in_name

)

Remove the image definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the image to remove.

Returns

A reference to this PortfolioKey.

UndefineLinePattern()

PortfolioKey& HPS::PortfolioKey::UndefineLinePattern

(

char const *

in_name

)

Remove the line pattern definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the line pattern to remove.

Returns

A reference to this PortfolioKey.

UndefineMaterialPalette()

PortfolioKey& HPS::PortfolioKey::UndefineMaterialPalette

(

char const *

in_name

)

Remove the material palette definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the material palette to remove.

Returns

A reference to this PortfolioKey.

UndefineNamedStyle()

PortfolioKey& HPS::PortfolioKey::UndefineNamedStyle

(

char const *

in_name

)

Remove the named style definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the named style to remove.

Returns

A reference to this PortfolioKey.

UndefineShader()

PortfolioKey& HPS::PortfolioKey::UndefineShader

(

char const *

in_name

)

Internal use only - customers should not use. Remove the shader definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the shader to remove.

Returns

A reference to this PortfolioKey.

UndefineShape()

PortfolioKey& HPS::PortfolioKey::UndefineShape

(

char const *

in_name

)

Remove the shape definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the shape to remove.

Returns

A reference to this PortfolioKey.

UndefineTexture()

PortfolioKey& HPS::PortfolioKey::UndefineTexture

(

char const *

in_name

)

Remove the texture definition with the specified name from this portfolio.

Parameters

in_name

UTF8-encoded name of the texture to remove.

Returns

A reference to this PortfolioKey.

---

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

• include/hps.h