BasePresetAssetTypeInterface Class Reference

#include <base_preset_asset.h>

Inheritance diagram for BasePresetAssetTypeInterface:

Detailed Description

BasePresetAssetTypeInterface defines a new preset type and is the connector to BasePresetAssetInterface.

Public Member Functions
MAXON_METHOD String	GetName () const
MAXON_METHOD Bool	LoadPreset (const BasePresetAsset &preset, const PresetLoadArgs &target) const
MAXON_METHOD Result< void >	CreateNewPresetSettings (CreatePresetAssetStruct &args) const
MAXON_METHOD String	GetFilterString () const
MAXON_METHOD Bool	DoesSupportSetAsDefault () const
MAXON_METHOD Id	GetSuggestedCategory () const

Private Member Functions
	MAXON_INTERFACE (BasePresetAssetTypeInterface, MAXON_REFERENCE_CONST, "net.maxon.interface.basepresetassettype")

Member Function Documentation

MAXON_INTERFACE()

MAXON_INTERFACE ( BasePresetAssetTypeInterface  , MAXON_REFERENCE_CONST  , "net.maxon.interface.basepresetassettype"    )

private

GetName()

MAXON_METHOD String GetName

(

)

const

GetName returns the preset type name.

Returns

Name of the preset type.

LoadPreset()

MAXON_METHOD Bool LoadPreset	(	const BasePresetAsset &	preset,
		const PresetLoadArgs &	target
	)		const

LoadPreset loads the preset into memory.

Parameters

[in]	preset	Preset to load
[in]	target	Arguments to use when loading the preset.

Returns

True on success.

CreateNewPresetSettings()

MAXON_METHOD Result<void> CreateNewPresetSettings

(

CreatePresetAssetStruct &

args

)

const

CreateNewPresetSettings creates the new preset of this type.

Parameters

[in]

args

see CreatePresetAssetStruct.

Returns

OK on success.

GetFilterString()

MAXON_METHOD String GetFilterString

(

)

const

GetFilterString returns the default filter string to search for this asset type in the asset browser.

DoesSupportSetAsDefault()

MAXON_METHOD Bool DoesSupportSetAsDefault

(

)

const

Returns true if the preset asset supports being set as default.

See also

AssetCreationInterface::SetDefaultObject.

Returns

True if supported.

GetSuggestedCategory()

MAXON_METHOD Id GetSuggestedCategory

(

)

const

Reads the default category identifier as suggested by the asset type.

Returns

The category identifier. Empty if no default suggestion.