
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static bool | operator!= (HPS.Key a, HPS.Key b) |
static bool | operator== (HPS.Key a, HPS.Key b) |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
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]
|
inline |
The default constructor creates an uninitialized PortfolioKey object. The Type() function will return Type.None.
◆ PortfolioKey() [2/3]
|
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]
|
inline |
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.
Member Function Documentation
◆ DefineCubeMap() [1/2]
|
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_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]
|
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_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()
|
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_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()
|
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_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()
|
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_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()
|
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_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.
◆ DefineNamedStyle()
|
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_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.
◆ DefineShape()
|
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_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]
|
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_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]
|
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_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.
◆ ImportAllCubeMaps() [1/2]
|
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_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.
◆ ImportAllCubeMaps() [2/2]
|
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_portfolio The source portfolio to copy the cube map definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllGlyphs() [1/2]
|
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_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.
◆ ImportAllGlyphs() [2/2]
|
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_portfolio The source portfolio to copy the glyph definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllImages() [1/2]
|
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_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.
◆ ImportAllImages() [2/2]
|
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_portfolio The source portfolio to copy the image definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllLinePatterns() [1/2]
|
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_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.
◆ ImportAllLinePatterns() [2/2]
|
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_portfolio The source portfolio to copy the line pattern definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllMaterialPalettes() [1/2]
|
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_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.
◆ ImportAllMaterialPalettes() [2/2]
|
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_portfolio The source portfolio to copy the material palette definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllNamedStyles() [1/2]
|
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_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.
◆ ImportAllNamedStyles() [2/2]
|
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_portfolio The source portfolio to copy the named style definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllShapes() [1/2]
|
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_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.
◆ ImportAllShapes() [2/2]
|
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_portfolio The source portfolio to copy the shape definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportAllTextures() [1/2]
|
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_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.
◆ ImportAllTextures() [2/2]
|
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_portfolio The source portfolio to copy the texture definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportCubeMap()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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() [1/2]
|
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_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.
◆ ImportPortfolio() [2/2]
|
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_portfolio The source portfolio to copy the definitions from.
- Returns
- A reference to this PortfolioKey.
◆ ImportShape()
|
inline |
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()
|
inline |
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()
|
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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.
◆ ShowAllShapeDefinitions()
|
inline |
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()
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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.
◆ ShowShapeDefinition() [1/2]
|
inline |
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]
|
inline |
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]
|
inline |
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]
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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()
|
inline |
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.
◆ UndefineShape()
|
inline |
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()
|
inline |
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:
- internals/hps_core/source/cs/HPS.PortfolioKey.cs