Inheritance diagram for HPS.PortfolioKey:
HPS.Key HPS.Object

Public Member Functions

HPS.CubeMapDefinition DefineCubeMap (string in_name, HPS.ImageDefinition in_negative_z, HPS.ImageDefinition in_positive_z, HPS.ImageDefinition in_negative_x, HPS.ImageDefinition in_positive_x, HPS.ImageDefinition in_negative_y, HPS.ImageDefinition in_positive_y)
 
HPS.CubeMapDefinition DefineCubeMap (string in_name, HPS.ImageDefinition in_negative_z, HPS.ImageDefinition in_positive_z, HPS.ImageDefinition in_negative_x, HPS.ImageDefinition in_positive_x, HPS.ImageDefinition in_negative_y, HPS.ImageDefinition in_positive_y, HPS.TextureOptionsKit in_options)
 
HPS.GlyphDefinition DefineGlyph (string in_name, HPS.GlyphKit in_source)
 
HPS.ImageDefinition DefineImage (string in_name, HPS.ImageKit in_source)
 
HPS.LinePatternDefinition DefineLinePattern (string in_name, HPS.LinePatternKit in_source)
 
HPS.MaterialPaletteDefinition DefineMaterialPalette (string in_name, HPS.MaterialKit[] in_source)
 
HPS.NamedStyleDefinition DefineNamedStyle (string in_name, HPS.SegmentKey in_style_source)
 
HPS.ShapeDefinition DefineShape (string in_name, HPS.ShapeKit in_source)
 
HPS.TextureDefinition DefineTexture (string in_name, HPS.ImageDefinition in_source)
 
HPS.TextureDefinition DefineTexture (string in_name, HPS.ImageDefinition in_source, HPS.TextureOptionsKit in_options)
 
override void Dispose ()
 
ulong GetCubeMapDefinitionCount ()
 
ulong GetDefinitionCount ()
 
ulong GetGlyphDefinitionCount ()
 
ulong GetImageDefinitionCount ()
 
ulong GetLinePatternDefinitionCount ()
 
ulong GetMaterialPaletteDefinitionCount ()
 
ulong GetNamedStyleDefinitionCount ()
 
ulong GetShapeDefinitionCount ()
 
ulong GetTextureDefinitionCount ()
 
HPS.PortfolioKey ImportAllCubeMaps (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllCubeMaps (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllGlyphs (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllGlyphs (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllImages (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllImages (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllLinePatterns (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllLinePatterns (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllMaterialPalettes (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllMaterialPalettes (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllNamedStyles (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllNamedStyles (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllShapes (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllShapes (HPS.PortfolioKey in_portfolio)
 
HPS.PortfolioKey ImportAllTextures (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportAllTextures (HPS.PortfolioKey in_portfolio)
 
HPS.CubeMapDefinition ImportCubeMap (HPS.CubeMapDefinition in_definition)
 
HPS.GlyphDefinition ImportGlyph (HPS.GlyphDefinition in_definition)
 
HPS.ImageDefinition ImportImage (HPS.ImageDefinition in_definition)
 
HPS.LinePatternDefinition ImportLinePattern (HPS.LinePatternDefinition in_definition)
 
HPS.MaterialPaletteDefinition ImportMaterialPalette (HPS.MaterialPaletteDefinition in_definition)
 
HPS.NamedStyleDefinition ImportNamedStyle (HPS.NamedStyleDefinition in_definition)
 
HPS.PortfolioKey ImportPortfolio (HPS.PortfolioKey in_portfolio, bool in_replace_existing)
 
HPS.PortfolioKey ImportPortfolio (HPS.PortfolioKey in_portfolio)
 
HPS.ShapeDefinition ImportShape (HPS.ShapeDefinition in_definition)
 
HPS.TextureDefinition ImportTexture (HPS.TextureDefinition in_definition)
 
override HPS.Type ObjectType ()
 
 PortfolioKey ()
 
 PortfolioKey (HPS.Key in_that)
 
 PortfolioKey (HPS.PortfolioKey in_that)
 
bool ShowAllCubeMapDefinitions (out HPS.CubeMapDefinition[] out_definitions)
 
bool ShowAllGlyphDefinitions (out HPS.GlyphDefinition[] out_definitions)
 
bool ShowAllImageDefinitions (out HPS.ImageDefinition[] out_definitions)
 
bool ShowAllLinePatternDefinitions (out HPS.LinePatternDefinition[] out_definitions)
 
bool ShowAllMaterialPaletteDefinitions (out HPS.MaterialPaletteDefinition[] out_definitions)
 
bool ShowAllNamedStyleDefinitions (out HPS.NamedStyleDefinition[] out_definitions)
 
bool ShowAllShapeDefinitions (out HPS.ShapeDefinition[] out_definitions)
 
bool ShowAllTextureDefinitions (out HPS.TextureDefinition[] out_definitions)
 
bool ShowCubeMapDefinition (string in_name)
 
bool ShowCubeMapDefinition (string in_name, out HPS.CubeMapDefinition out_found)
 
bool ShowGlyphDefinition (string in_name)
 
bool ShowGlyphDefinition (string in_name, out HPS.GlyphDefinition out_found)
 
bool ShowImageDefinition (string in_name)
 
bool ShowImageDefinition (string in_name, out HPS.ImageDefinition out_found)
 
bool ShowLinePatternDefinition (string in_name)
 
bool ShowLinePatternDefinition (string in_name, out HPS.LinePatternDefinition out_found)
 
bool ShowMaterialPaletteDefinition (string in_name)
 
bool ShowMaterialPaletteDefinition (string in_name, out HPS.MaterialPaletteDefinition out_found)
 
bool ShowNamedStyleDefinition (string in_name)
 
bool ShowNamedStyleDefinition (string in_name, out HPS.NamedStyleDefinition out_found)
 
bool ShowShapeDefinition (string in_name)
 
bool ShowShapeDefinition (string in_name, out HPS.ShapeDefinition out_found)
 
bool ShowTextureDefinition (string in_name)
 
bool ShowTextureDefinition (string in_name, out HPS.TextureDefinition out_found)
 
HPS.PortfolioKey UndefineCubeMap (string in_name)
 
HPS.PortfolioKey UndefineGlyph (string in_name)
 
HPS.PortfolioKey UndefineImage (string in_name)
 
HPS.PortfolioKey UndefineLinePattern (string in_name)
 
HPS.PortfolioKey UndefineMaterialPalette (string in_name)
 
HPS.PortfolioKey UndefineNamedStyle (string in_name)
 
HPS.PortfolioKey UndefineShape (string in_name)
 
HPS.PortfolioKey UndefineTexture (string in_name)
 
- Public Member Functions inherited from HPS.Key
virtual void Assign (HPS.Key in_that)
 
HPS.Key CopyTo (HPS.SegmentKey in_destination)
 
void Delete ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Key in_that)
 
ulong GetHash ()
 
override int GetHashCode ()
 
bool HasOwner ()
 
 Key ()
 
 Key (HPS.Key in_that)
 
 Key (HPS.Control in_control)
 
void MoveTo (HPS.SegmentKey in_new_owner)
 
HPS.SegmentKey Owner ()
 
HPS.SegmentKey Up ()
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Key
static bool operator!= (HPS.Key a, HPS.Key b)
 
static bool operator== (HPS.Key a, HPS.Key b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/3]

HPS.PortfolioKey.PortfolioKey ( )
inline

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

◆ PortfolioKey() [2/3]

HPS.PortfolioKey.PortfolioKey ( HPS.Key  in_that)
inline

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.

◆ PortfolioKey() [3/3]

HPS.PortfolioKey.PortfolioKey ( HPS.PortfolioKey  in_that)
inline

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

Parameters
in_thatThe source PortfolioKey to copy.

Member Function Documentation

◆ DefineCubeMap() [1/2]

HPS.CubeMapDefinition HPS.PortfolioKey.DefineCubeMap ( string  in_name,
HPS.ImageDefinition  in_negative_z,
HPS.ImageDefinition  in_positive_z,
HPS.ImageDefinition  in_negative_x,
HPS.ImageDefinition  in_positive_x,
HPS.ImageDefinition  in_negative_y,
HPS.ImageDefinition  in_positive_y 
)
inline

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_nameUTF8-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_zThe source image for the negative z-axis for the new cube map definition.
in_positive_zThe source image for the positive z-axis for the new cube map definition.
in_negative_xThe source image for the negative x-axis for the new cube map definition.
in_positive_xThe source image for the positive x-axis for the new cube map definition.
in_negative_yThe source image for the negative y-axis for the new cube map definition.
in_positive_yThe source image for the positive y-axis for the new cube map definition.
Returns
A newly created CubeMapDefinition.

◆ DefineCubeMap() [2/2]

HPS.CubeMapDefinition HPS.PortfolioKey.DefineCubeMap ( string  in_name,
HPS.ImageDefinition  in_negative_z,
HPS.ImageDefinition  in_positive_z,
HPS.ImageDefinition  in_negative_x,
HPS.ImageDefinition  in_positive_x,
HPS.ImageDefinition  in_negative_y,
HPS.ImageDefinition  in_positive_y,
HPS.TextureOptionsKit  in_options 
)
inline

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_nameUTF8-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_zThe source image for the negative z-axis for the new cube map definition.
in_positive_zThe source image for the positive z-axis for the new cube map definition.
in_negative_xThe source image for the negative x-axis for the new cube map definition.
in_positive_xThe source image for the positive x-axis for the new cube map definition.
in_negative_yThe source image for the negative y-axis for the new cube map definition.
in_positive_yThe source image for the positive y-axis for the new cube map definition.
in_optionsThe texture options for the new cube map definition.
Returns
A newly created CubeMapDefinition.

◆ DefineGlyph()

HPS.GlyphDefinition HPS.PortfolioKey.DefineGlyph ( string  in_name,
HPS.GlyphKit  in_source 
)
inline

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_nameUTF8-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_sourceThe source GlyphKit for the new glyph definition.
Returns
A newly created GlyphDefinition.

◆ DefineImage()

HPS.ImageDefinition HPS.PortfolioKey.DefineImage ( string  in_name,
HPS.ImageKit  in_source 
)
inline

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_nameUTF8-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_sourceThe source ImageKit for the new image definition.
Returns
A newly created ImageDefinition.

◆ DefineLinePattern()

HPS.LinePatternDefinition HPS.PortfolioKey.DefineLinePattern ( string  in_name,
HPS.LinePatternKit  in_source 
)
inline

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_nameUTF8-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_sourceThe source LinePatternKit for the new line pattern definition.
Returns
A newly created LinePatternDefinition.

◆ DefineMaterialPalette()

HPS.MaterialPaletteDefinition HPS.PortfolioKey.DefineMaterialPalette ( string  in_name,
HPS.MaterialKit []  in_source 
)
inline

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_nameUTF8-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_sourceThe source MaterialKit array for the new material palette definition.
Returns
A newly created MaterialPaletteDefinition.

◆ DefineNamedStyle()

HPS.NamedStyleDefinition HPS.PortfolioKey.DefineNamedStyle ( string  in_name,
HPS.SegmentKey  in_style_source 
)
inline

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_nameUTF8-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_sourceThe source SegmentKey for the new named style definition.
Returns
A newly created NamedStyleDefinition.

◆ DefineShape()

HPS.ShapeDefinition HPS.PortfolioKey.DefineShape ( string  in_name,
HPS.ShapeKit  in_source 
)
inline

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_nameUTF8-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_sourceThe source ShapeKit for the new shape definition.
Returns
A newly created ShapeDefinition.

◆ DefineTexture() [1/2]

HPS.TextureDefinition HPS.PortfolioKey.DefineTexture ( string  in_name,
HPS.ImageDefinition  in_source 
)
inline

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_nameUTF8-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_sourceThe source image for the new texture definition.
Returns
A newly created TextureDefinition.

◆ DefineTexture() [2/2]

HPS.TextureDefinition HPS.PortfolioKey.DefineTexture ( string  in_name,
HPS.ImageDefinition  in_source,
HPS.TextureOptionsKit  in_options 
)
inline

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_nameUTF8-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_sourceThe source image for the new texture definition.
in_optionsThe texture options for the new texture definition.
Returns
A newly created TextureDefinition.

◆ ImportAllCubeMaps() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllCubeMaps ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the cube map definitions from.
in_replace_existingWhether to replace existing cube map definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllCubeMaps() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllCubeMaps ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the cube map definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllGlyphs() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllGlyphs ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the glyph definitions from.
in_replace_existingWhether to replace existing glyph definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllGlyphs() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllGlyphs ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the glyph definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllImages() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllImages ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the image definitions from.
in_replace_existingWhether to replace existing image definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllImages() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllImages ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the image definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllLinePatterns() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllLinePatterns ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the line pattern definitions from.
in_replace_existingWhether to replace existing line pattern definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllLinePatterns() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllLinePatterns ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the line pattern definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllMaterialPalettes() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllMaterialPalettes ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the material palette definitions from.
in_replace_existingWhether to replace existing material palette definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllMaterialPalettes() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllMaterialPalettes ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the material palette definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllNamedStyles() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllNamedStyles ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the named style definitions from.
in_replace_existingWhether to replace existing named style definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllNamedStyles() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllNamedStyles ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the named style definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllShapes() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllShapes ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the shape definitions from.
in_replace_existingWhether to replace existing shape definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllShapes() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllShapes ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the shape definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportAllTextures() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllTextures ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the texture definitions from.
in_replace_existingWhether to replace existing texture definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportAllTextures() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportAllTextures ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the texture definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportCubeMap()

HPS.CubeMapDefinition HPS.PortfolioKey.ImportCubeMap ( HPS.CubeMapDefinition  in_definition)
inline

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

Parameters
in_definitionThe source cube map definition to copy into this portfolio.
Returns
A newly created CubeMapDefinition.

◆ ImportGlyph()

HPS.GlyphDefinition HPS.PortfolioKey.ImportGlyph ( HPS.GlyphDefinition  in_definition)
inline

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

Parameters
in_definitionThe source glyph definition to copy into this portfolio.
Returns
A newly created GlyphDefinition.

◆ ImportImage()

HPS.ImageDefinition HPS.PortfolioKey.ImportImage ( HPS.ImageDefinition  in_definition)
inline

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

Parameters
in_definitionThe source image definition to copy into this portfolio.
Returns
A newly created ImageDefinition.

◆ ImportLinePattern()

HPS.LinePatternDefinition HPS.PortfolioKey.ImportLinePattern ( HPS.LinePatternDefinition  in_definition)
inline

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

Parameters
in_definitionThe source line pattern definition to copy into this portfolio.
Returns
A newly created LinePatternDefinition.

◆ ImportMaterialPalette()

HPS.MaterialPaletteDefinition HPS.PortfolioKey.ImportMaterialPalette ( HPS.MaterialPaletteDefinition  in_definition)
inline

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

Parameters
in_definitionThe source material palette definition to copy into this portfolio.
Returns
A newly created MaterialPaletteDefinition.

◆ ImportNamedStyle()

HPS.NamedStyleDefinition HPS.PortfolioKey.ImportNamedStyle ( HPS.NamedStyleDefinition  in_definition)
inline

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

Parameters
in_definitionThe source named style definition to copy into this portfolio.
Returns
A newly created NamedStyleDefinition.

◆ ImportPortfolio() [1/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportPortfolio ( HPS.PortfolioKey  in_portfolio,
bool  in_replace_existing 
)
inline

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_portfolioThe source portfolio to copy the definitions from.
in_replace_existingWhether to replace existing definitions of the same name. Defaults to true.
Returns
A reference to this PortfolioKey.

◆ ImportPortfolio() [2/2]

HPS.PortfolioKey HPS.PortfolioKey.ImportPortfolio ( HPS.PortfolioKey  in_portfolio)
inline

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_portfolioThe source portfolio to copy the definitions from.
Returns
A reference to this PortfolioKey.

◆ ImportShape()

HPS.ShapeDefinition HPS.PortfolioKey.ImportShape ( HPS.ShapeDefinition  in_definition)
inline

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

Parameters
in_definitionThe source shape definition to copy into this portfolio.
Returns
A newly created ShapeDefinition.

◆ ImportTexture()

HPS.TextureDefinition HPS.PortfolioKey.ImportTexture ( HPS.TextureDefinition  in_definition)
inline

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

Parameters
in_definitionThe source texture definition to copy into this portfolio.
Returns
A newly created TextureDefinition.

◆ ObjectType()

override HPS.Type HPS.PortfolioKey.ObjectType ( )
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.

◆ ShowAllCubeMapDefinitions()

bool HPS.PortfolioKey.ShowAllCubeMapDefinitions ( out HPS.CubeMapDefinition []  out_definitions)
inline

Shows all cube maps defined within this portfolio.

Parameters
out_definitionsThe 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 ( out HPS.GlyphDefinition []  out_definitions)
inline

Shows all glyphs defined within this portfolio.

Parameters
out_definitionsThe array of glyphs defined within this portfolio.
Returns
true if any glyphs are defined in this portfolio, false otherwise.

◆ ShowAllImageDefinitions()

bool HPS.PortfolioKey.ShowAllImageDefinitions ( out HPS.ImageDefinition []  out_definitions)
inline

Shows all images defined within this portfolio.

Parameters
out_definitionsThe array of images defined within this portfolio.
Returns
true if any images are defined in this portfolio, false otherwise.

◆ ShowAllLinePatternDefinitions()

bool HPS.PortfolioKey.ShowAllLinePatternDefinitions ( out HPS.LinePatternDefinition []  out_definitions)
inline

Shows all line patterns defined within this portfolio.

Parameters
out_definitionsThe 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 ( out HPS.MaterialPaletteDefinition []  out_definitions)
inline

Shows all material palettes defined within this portfolio.

Parameters
out_definitionsThe 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 ( out HPS.NamedStyleDefinition []  out_definitions)
inline

Shows all named styles defined within this portfolio.

Parameters
out_definitionsThe array of named styles defined within this portfolio.
Returns
true if any named styles are defined in this portfolio, false otherwise.

◆ ShowAllShapeDefinitions()

bool HPS.PortfolioKey.ShowAllShapeDefinitions ( out HPS.ShapeDefinition []  out_definitions)
inline

Shows all shapes defined within this portfolio.

Parameters
out_definitionsThe array of shapes defined within this portfolio.
Returns
true if any shapes are defined in this portfolio, false otherwise.

◆ ShowAllTextureDefinitions()

bool HPS.PortfolioKey.ShowAllTextureDefinitions ( out HPS.TextureDefinition []  out_definitions)
inline

Shows all textures defined within this portfolio.

Parameters
out_definitionsThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.CubeMapDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the cube map to find in this portfolio.
out_foundThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.GlyphDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the glyph to find in this portfolio.
out_foundThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.ImageDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the image to find in this portfolio.
out_foundThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.LinePatternDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the line pattern to find in this portfolio.
out_foundThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.MaterialPaletteDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the material palette to find in this portfolio.
out_foundThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.NamedStyleDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the named style to find in this portfolio.
out_foundThe 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.

◆ ShowShapeDefinition() [1/2]

bool HPS.PortfolioKey.ShowShapeDefinition ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.ShapeDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the shape to find in this portfolio.
out_foundThe 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 ( string  in_name)
inline

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

Parameters
in_nameUTF8-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 ( string  in_name,
out HPS.TextureDefinition  out_found 
)
inline

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

Parameters
in_nameUTF8-encoded name of the texture to find in this portfolio.
out_foundThe texture definition from this portfolio with the specified name.
Returns
true if a texture definition with the specified name was found, false otherwise.

◆ UndefineCubeMap()

HPS.PortfolioKey HPS.PortfolioKey.UndefineCubeMap ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the cube map to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineGlyph()

HPS.PortfolioKey HPS.PortfolioKey.UndefineGlyph ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the glyph to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineImage()

HPS.PortfolioKey HPS.PortfolioKey.UndefineImage ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the image to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineLinePattern()

HPS.PortfolioKey HPS.PortfolioKey.UndefineLinePattern ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the line pattern to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineMaterialPalette()

HPS.PortfolioKey HPS.PortfolioKey.UndefineMaterialPalette ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the material palette to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineNamedStyle()

HPS.PortfolioKey HPS.PortfolioKey.UndefineNamedStyle ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the named style to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineShape()

HPS.PortfolioKey HPS.PortfolioKey.UndefineShape ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the shape to remove.
Returns
A reference to this PortfolioKey.

◆ UndefineTexture()

HPS.PortfolioKey HPS.PortfolioKey.UndefineTexture ( string  in_name)
inline

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

Parameters
in_nameUTF8-encoded name of the texture to remove.
Returns
A reference to this PortfolioKey.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.PortfolioKey.cs