REFERENCE MANUAL
The PortfolioKey class is a smart pointer to a database object. More...
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) |
Creates a new cube map definition in this portfolio with the specified name, based on the specified images and with the default texture options. More... | |
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) |
Creates a new cube map definition in this portfolio with the specified name, based on the specified images and with the specified texture options. More... | |
HPS.GlyphDefinition | DefineGlyph (string in_name, HPS.GlyphKit in_source) |
Creates a new glyph definition in this portfolio with the specified name using the source GlyphKit. More... | |
HPS.ImageDefinition | DefineImage (string in_name, HPS.ImageKit in_source) |
Creates a new image definition in this portfolio with the specified name from the source ImageKit. More... | |
HPS.LinePatternDefinition | DefineLinePattern (string in_name, HPS.LinePatternKit in_source) |
Creates a new line pattern definition in this portfolio with the specified name using the source LinePatternKit. More... | |
HPS.MaterialPaletteDefinition | DefineMaterialPalette (string in_name, HPS.MaterialKit[] in_source) |
Creates a new material palette definition in this portfolio with the specified name using the source MaterialKit array. More... | |
HPS.NamedStyleDefinition | DefineNamedStyle (string in_name, HPS.SegmentKey in_style_source) |
Creates a new named style definition in this portfolio with the specified name using the source SegmentKey. More... | |
HPS.ShaderDefinition | DefineShader (string in_name, HPS.ShaderKit in_source) |
Creates a new shader definition in this portfolio with the specified name using the source ShaderKit. More... | |
HPS.TextureDefinition | DefineTexture (string in_name, HPS.ImageDefinition 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. More... | |
HPS.TextureDefinition | DefineTexture (string in_name, HPS.ImageDefinition in_source, HPS.TextureOptionsKit 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. More... | |
override void | Dispose () |
ulong | GetCubeMapDefinitionCount () |
| |
ulong | GetDefinitionCount () |
| |
ulong | GetGlyphDefinitionCount () |
| |
ulong | GetImageDefinitionCount () |
| |
ulong | GetLinePatternDefinitionCount () |
| |
ulong | GetMaterialPaletteDefinitionCount () |
| |
ulong | GetNamedStyleDefinitionCount () |
| |
ulong | GetShaderDefinitionCount () |
| |
ulong | GetTextureDefinitionCount () |
| |
HPS.PortfolioKey | ImportAllCubeMaps (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all cube map definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllCubeMaps (HPS.PortfolioKey in_portfolio) |
Copy all cube map definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllGlyphs (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all glyph definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllGlyphs (HPS.PortfolioKey in_portfolio) |
Copy all glyph definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllImages (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all image definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllImages (HPS.PortfolioKey in_portfolio) |
Copy all image definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllLinePatterns (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all line pattern definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllLinePatterns (HPS.PortfolioKey in_portfolio) |
Copy all line pattern definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllMaterialPalettes (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all material palette definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllMaterialPalettes (HPS.PortfolioKey in_portfolio) |
Copy all material palette definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllNamedStyles (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all named style definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllNamedStyles (HPS.PortfolioKey in_portfolio) |
Copy all named style definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllShaders (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all shader definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllShaders (HPS.PortfolioKey in_portfolio) |
Copy all shader definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllTextures (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all texture definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportAllTextures (HPS.PortfolioKey in_portfolio) |
Copy all texture definitions from the specified portfolio into this portfolio. More... | |
HPS.CubeMapDefinition | ImportCubeMap (HPS.CubeMapDefinition in_definition) |
Copy the specified cube map definition into this portfolio. More... | |
HPS.GlyphDefinition | ImportGlyph (HPS.GlyphDefinition in_definition) |
Copy the specified glyph definition into this portfolio. More... | |
HPS.ImageDefinition | ImportImage (HPS.ImageDefinition in_definition) |
Copy the specified image definition into this portfolio. More... | |
HPS.LinePatternDefinition | ImportLinePattern (HPS.LinePatternDefinition in_definition) |
Copy the specified line pattern definition into this portfolio. More... | |
HPS.MaterialPaletteDefinition | ImportMaterialPalette (HPS.MaterialPaletteDefinition in_definition) |
Copy the specified material palette definition into this portfolio. More... | |
HPS.NamedStyleDefinition | ImportNamedStyle (HPS.NamedStyleDefinition in_definition) |
Copy the specified named style definition into this portfolio. More... | |
HPS.PortfolioKey | ImportPortfolio (HPS.PortfolioKey in_portfolio, bool in_replace_existing) |
Copy all definitions from the specified portfolio into this portfolio. More... | |
HPS.PortfolioKey | ImportPortfolio (HPS.PortfolioKey in_portfolio) |
Copy all definitions from the specified portfolio into this portfolio. More... | |
HPS.ShaderDefinition | ImportShader (HPS.ShaderDefinition in_definition) |
Copy the specified shader definition into this portfolio. More... | |
HPS.TextureDefinition | ImportTexture (HPS.TextureDefinition in_definition) |
Copy the specified texture definition into this portfolio. More... | |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
PortfolioKey () | |
The default constructor creates an uninitialized PortfolioKey object. More... | |
PortfolioKey (HPS.Key in_that) | |
This constructor creates a PortfolioKey object that shares the underlying smart-pointer of the source Key. More... | |
PortfolioKey (HPS.PortfolioKey in_that) | |
This constructor creates a PortfolioKey object that shares the underlying smart-pointer of the source Key. More... | |
bool | ShowAllCubeMapDefinitions (out HPS.CubeMapDefinition[] out_definitions) |
Shows all cube maps defined within this portfolio. More... | |
bool | ShowAllGlyphDefinitions (out HPS.GlyphDefinition[] out_definitions) |
Shows all glyphs defined within this portfolio. More... | |
bool | ShowAllImageDefinitions (out HPS.ImageDefinition[] out_definitions) |
Shows all images defined within this portfolio. More... | |
bool | ShowAllLinePatternDefinitions (out HPS.LinePatternDefinition[] out_definitions) |
Shows all line patterns defined within this portfolio. More... | |
bool | ShowAllMaterialPaletteDefinitions (out HPS.MaterialPaletteDefinition[] out_definitions) |
Shows all material palettes defined within this portfolio. More... | |
bool | ShowAllNamedStyleDefinitions (out HPS.NamedStyleDefinition[] out_definitions) |
Shows all named styles defined within this portfolio. More... | |
bool | ShowAllShaderDefinitions (out HPS.ShaderDefinition[] out_definitions) |
Shows all shaders defined within this portfolio. More... | |
bool | ShowAllTextureDefinitions (out HPS.TextureDefinition[] out_definitions) |
Shows all textures defined within this portfolio. More... | |
bool | ShowCubeMapDefinition (string in_name, out HPS.CubeMapDefinition out_found) |
Finds the cube map definition with the specified name in this portfolio. More... | |
bool | ShowGlyphDefinition (string in_name, out HPS.GlyphDefinition out_found) |
Finds the glyph definition with the specified name in this portfolio. More... | |
bool | ShowImageDefinition (string in_name, out HPS.ImageDefinition out_found) |
Finds the image definition with the specified name in this portfolio. More... | |
bool | ShowLinePatternDefinition (string in_name, out HPS.LinePatternDefinition out_found) |
Finds the line pattern definition with the specified name in this portfolio. More... | |
bool | ShowMaterialPaletteDefinition (string in_name, out HPS.MaterialPaletteDefinition out_found) |
Finds the material palette definition with the specified name in this portfolio. More... | |
bool | ShowNamedStyleDefinition (string in_name, out HPS.NamedStyleDefinition out_found) |
Finds the named style definition with the specified name in this portfolio. More... | |
bool | ShowShaderDefinition (string in_name, out HPS.ShaderDefinition out_found) |
Finds the shader definition with the specified name in this portfolio. More... | |
bool | ShowTextureDefinition (string in_name, out HPS.TextureDefinition out_found) |
Finds the texture definition with the specified name in this portfolio. More... | |
HPS.PortfolioKey | UndefineCubeMap (string in_name) |
Remove the cube map definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineGlyph (string in_name) |
Remove the glyph definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineImage (string in_name) |
Remove the image definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineLinePattern (string in_name) |
Remove the line pattern definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineMaterialPalette (string in_name) |
Remove the material palette definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineNamedStyle (string in_name) |
Remove the named style definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineShader (string in_name) |
Remove the shader definition with the specified name from this portfolio. More... | |
HPS.PortfolioKey | UndefineTexture (string in_name) |
Remove the texture definition with the specified name from this portfolio. More... | |
![]() | |
virtual void | Assign (HPS.Key in_that) |
Share the smart-pointer. More... | |
HPS.Key | CopyTo (HPS.SegmentKey in_destination) |
Copies the database object referred to by this key into a segment pointed to by in_destination. More... | |
void | Delete () |
Removes the database object referred to by this key. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Key in_that) |
Determines whether the database objects pointed to by this key and in_that are the same. More... | |
ulong | GetHash () |
Returns a hash code for the key. More... | |
override int | GetHashCode () |
bool | HasOwner () |
| |
Key () | |
An uninitialized key refers to no database object and Type() will return Type::None. More... | |
Key (HPS.Key in_that) | |
Shares a reference to a database object referred to by in_that. More... | |
Key (HPS.Control in_control) | |
Initializes a key tied to the Control in_control. More... | |
void | MoveTo (HPS.SegmentKey in_new_owner) |
Moves the database object referred to by this key into a new containing segment pointed to by in_new_owner. More... | |
HPS.SegmentKey | Owner () |
| |
HPS.SegmentKey | Up () |
| |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
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 |
HandleRef | scptr |
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.
HPS.PortfolioKey.PortfolioKey | ( | ) |
The default constructor creates an uninitialized PortfolioKey object.
The Type() function will return Type::None.
HPS.PortfolioKey.PortfolioKey | ( | HPS.Key | in_that | ) |
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.
HPS.PortfolioKey.PortfolioKey | ( | HPS.PortfolioKey | in_that | ) |
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.
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 | ||
) |
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.
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. |
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 | ||
) |
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.
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. |
HPS.GlyphDefinition HPS.PortfolioKey.DefineGlyph | ( | string | in_name, |
HPS.GlyphKit | 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.
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 <ref refid="class_h_p_s_1_1_glyph_kit" kindref="compound">GlyphKit</ref> for the new glyph definition. |
HPS.ImageDefinition HPS.PortfolioKey.DefineImage | ( | string | in_name, |
HPS.ImageKit | 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.
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 <ref refid="class_h_p_s_1_1_image_kit" kindref="compound">ImageKit</ref> for the new image definition. |
HPS.LinePatternDefinition HPS.PortfolioKey.DefineLinePattern | ( | string | in_name, |
HPS.LinePatternKit | 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.
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 <ref refid="class_h_p_s_1_1_line_pattern_kit" kindref="compound">LinePatternKit</ref> for the new line pattern definition. |
HPS.MaterialPaletteDefinition HPS.PortfolioKey.DefineMaterialPalette | ( | string | in_name, |
HPS.MaterialKit[] | 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.
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 <ref refid="class_h_p_s_1_1_material_kit" kindref="compound">MaterialKit</ref> array for the new material palette definition. |
HPS.NamedStyleDefinition HPS.PortfolioKey.DefineNamedStyle | ( | string | in_name, |
HPS.SegmentKey | 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.
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 <ref refid="class_h_p_s_1_1_segment_key" kindref="compound">SegmentKey</ref> for the new named style definition. |
HPS.ShaderDefinition HPS.PortfolioKey.DefineShader | ( | string | in_name, |
HPS.ShaderKit | in_source | ||
) |
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.
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 <ref refid="class_h_p_s_1_1_shader_kit" kindref="compound">ShaderKit</ref> for the new shader definition. |
HPS.TextureDefinition HPS.PortfolioKey.DefineTexture | ( | string | in_name, |
HPS.ImageDefinition | 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.
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. |
HPS.TextureDefinition HPS.PortfolioKey.DefineTexture | ( | string | in_name, |
HPS.ImageDefinition | in_source, | ||
HPS.TextureOptionsKit | 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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllCubeMaps | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllCubeMaps | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the cube map definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllGlyphs | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllGlyphs | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the glyph definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllImages | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllImages | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the image definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllLinePatterns | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllLinePatterns | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the line pattern definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllMaterialPalettes | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllMaterialPalettes | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the material palette definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllNamedStyles | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllNamedStyles | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the named style definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllShaders | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllShaders | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the shader definitions from. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllTextures | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportAllTextures | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the texture definitions from. |
HPS.CubeMapDefinition HPS.PortfolioKey.ImportCubeMap | ( | HPS.CubeMapDefinition | in_definition | ) |
Copy the specified cube map definition into this portfolio.
This will replace an existing cube map definition of the same name.
in_definition | The source cube map definition to copy into this portfolio. |
HPS.GlyphDefinition HPS.PortfolioKey.ImportGlyph | ( | HPS.GlyphDefinition | in_definition | ) |
Copy the specified glyph definition into this portfolio.
This will replace an existing glyph definition of the same name.
in_definition | The source glyph definition to copy into this portfolio. |
HPS.ImageDefinition HPS.PortfolioKey.ImportImage | ( | HPS.ImageDefinition | in_definition | ) |
Copy the specified image definition into this portfolio.
This will replace an existing image definition of the same name.
in_definition | The source image definition to copy into this portfolio. |
HPS.LinePatternDefinition HPS.PortfolioKey.ImportLinePattern | ( | HPS.LinePatternDefinition | in_definition | ) |
Copy the specified line pattern definition into this portfolio.
This will replace an existing line pattern definition of the same name.
in_definition | The source line pattern definition to copy into this portfolio. |
HPS.MaterialPaletteDefinition HPS.PortfolioKey.ImportMaterialPalette | ( | HPS.MaterialPaletteDefinition | in_definition | ) |
Copy the specified material palette definition into this portfolio.
This will replace an existing material palette definition of the same name.
in_definition | The source material palette definition to copy into this portfolio. |
HPS.NamedStyleDefinition HPS.PortfolioKey.ImportNamedStyle | ( | HPS.NamedStyleDefinition | in_definition | ) |
Copy the specified named style definition into this portfolio.
This will replace an existing named style definition of the same name.
in_definition | The source named style definition to copy into this portfolio. |
HPS.PortfolioKey HPS.PortfolioKey.ImportPortfolio | ( | HPS.PortfolioKey | in_portfolio, |
bool | in_replace_existing | ||
) |
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.
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. |
HPS.PortfolioKey HPS.PortfolioKey.ImportPortfolio | ( | HPS.PortfolioKey | in_portfolio | ) |
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.
in_portfolio | The source portfolio to copy the definitions from. |
HPS.ShaderDefinition HPS.PortfolioKey.ImportShader | ( | HPS.ShaderDefinition | in_definition | ) |
Copy the specified shader definition into this portfolio.
This will replace an existing shader definition of the same name.
in_definition | The source shader definition to copy into this portfolio. |
HPS.TextureDefinition HPS.PortfolioKey.ImportTexture | ( | HPS.TextureDefinition | in_definition | ) |
Copy the specified texture definition into this portfolio.
This will replace an existing texture definition of the same name.
in_definition | The source texture definition to copy into this portfolio. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Key.
bool HPS.PortfolioKey.ShowAllCubeMapDefinitions | ( | out HPS.CubeMapDefinition[] | out_definitions | ) |
Shows all cube maps defined within this portfolio.
out_definitions | The array of cube maps defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllGlyphDefinitions | ( | out HPS.GlyphDefinition[] | out_definitions | ) |
Shows all glyphs defined within this portfolio.
out_definitions | The array of glyphs defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllImageDefinitions | ( | out HPS.ImageDefinition[] | out_definitions | ) |
Shows all images defined within this portfolio.
out_definitions | The array of images defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllLinePatternDefinitions | ( | out HPS.LinePatternDefinition[] | out_definitions | ) |
Shows all line patterns defined within this portfolio.
out_definitions | The array of line patterns defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllMaterialPaletteDefinitions | ( | out HPS.MaterialPaletteDefinition[] | out_definitions | ) |
Shows all material palettes defined within this portfolio.
out_definitions | The array of material palettes defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllNamedStyleDefinitions | ( | out HPS.NamedStyleDefinition[] | out_definitions | ) |
Shows all named styles defined within this portfolio.
out_definitions | The array of named styles defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllShaderDefinitions | ( | out HPS.ShaderDefinition[] | out_definitions | ) |
Shows all shaders defined within this portfolio.
out_definitions | The array of shaders defined within this portfolio. |
bool HPS.PortfolioKey.ShowAllTextureDefinitions | ( | out HPS.TextureDefinition[] | out_definitions | ) |
Shows all textures defined within this portfolio.
out_definitions | The array of textures defined within this portfolio. |
bool HPS.PortfolioKey.ShowCubeMapDefinition | ( | string | in_name, |
out HPS.CubeMapDefinition | out_found | ||
) |
Finds the cube map definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowGlyphDefinition | ( | string | in_name, |
out HPS.GlyphDefinition | out_found | ||
) |
Finds the glyph definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowImageDefinition | ( | string | in_name, |
out HPS.ImageDefinition | out_found | ||
) |
Finds the image definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowLinePatternDefinition | ( | string | in_name, |
out HPS.LinePatternDefinition | out_found | ||
) |
Finds the line pattern definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowMaterialPaletteDefinition | ( | string | in_name, |
out HPS.MaterialPaletteDefinition | out_found | ||
) |
Finds the material palette definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowNamedStyleDefinition | ( | string | in_name, |
out HPS.NamedStyleDefinition | out_found | ||
) |
Finds the named style definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowShaderDefinition | ( | string | in_name, |
out HPS.ShaderDefinition | out_found | ||
) |
Finds the shader definition with the specified name in this portfolio.
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. |
bool HPS.PortfolioKey.ShowTextureDefinition | ( | string | in_name, |
out HPS.TextureDefinition | out_found | ||
) |
Finds the texture definition with the specified name in this portfolio.
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. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineCubeMap | ( | string | in_name | ) |
Remove the cube map definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the cube map to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineGlyph | ( | string | in_name | ) |
Remove the glyph definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the glyph to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineImage | ( | string | in_name | ) |
Remove the image definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the image to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineLinePattern | ( | string | in_name | ) |
Remove the line pattern definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the line pattern to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineMaterialPalette | ( | string | in_name | ) |
Remove the material palette definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the material palette to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineNamedStyle | ( | string | in_name | ) |
Remove the named style definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the named style to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineShader | ( | string | in_name | ) |
Remove the shader definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the shader to remove. |
HPS.PortfolioKey HPS.PortfolioKey.UndefineTexture | ( | string | in_name | ) |
Remove the texture definition with the specified name from this portfolio.
in_name | UTF8-encoded name of the texture to remove. |