UtilityInterface Namespace Reference

This reference page is linked to from the following overview topics: Incremental Improvements.

---

Enumerations
enum	EProductID { k3dsMax, k3dsMaxDesign }
	Identifiers for 3ds Max based products. More...
Functions
UtilExport const MCHAR *	GetRegistryKeyBase ()
	Returns the base product registry key: "SOFTWARE\<Company Name>\<Product Name>\<version>".
UtilExport const MCHAR *	GetRegistryCompanyBase ()
	Returns the base company registry key: "SOFTWARE\<Company Name>".
UtilExport const MCHAR *	GetRegistrySoftwareBase ()
	Returns the software base (i.e. SOFTWARE - should be static from release to release.)
UtilExport const MCHAR *	GetCompanyName ()
	Returns the company name (i.e. Autodesk). Mainly for branding purposes.
UtilExport const MCHAR *	GetProductName ()
	Returns the product name (i.e. 3dsmax).
UtilExport EProductID	GetProductID ()
	Allows to identify the product based on an identifier.
UtilExport const MCHAR *	GetCurrentVersion ()
	Returns the current release-number (major, minor release: #.#).
UtilExport bool	GetBoolEnvironmentVariable (const MCHAR *pEnvVarName, bool defaultVal)
	Returns the true/false value of an environment variable.
UtilExport void	DisplayOutOfMemoryWarning ()
	Display a warning telling the user the application is out of memory.
UtilExport bool	DisplayOutOfMemoryWarning (MCHAR *message)
	Displays a warning telling the user the application is out of memory.

---

Enumeration Type Documentation

enum EProductID

Search for all occurrences

Identifiers for 3ds Max based products.

Enumerator:

k3dsMax	3ds Max product identifier Search for all occurrences
k3dsMaxDesign	3ds Max Design product identifier Search for all occurrences

    {
        k3dsMax, 
        k3dsMaxDesign 
    };

---

Function Documentation

UtilExport const MCHAR* UtilityInterface::GetRegistryKeyBase

(

)

Search for all occurrences

Returns the base product registry key: "SOFTWARE\<Company Name>\<Product Name>\<version>".

Returns the base registry key. The application uses this key as the base for storing registry settings. A plugin can choose to store registry settings under the base (preferably in a subkey group), but likely will want store its registry settings under its own company root. Combines calls to GetRegistrySoftwareBase(), GetCompanyName(), GetProductName() and GetVersion(). Note: Tailing backslash is not appended.

Returns:

base-key in this format: "SOFTWARE\<Company Name>\<Product Name>\<version>"

UtilExport const MCHAR* UtilityInterface::GetRegistryCompanyBase

(

)

Search for all occurrences

Returns the base company registry key: "SOFTWARE\<Company Name>".

Returns the base company registry key. This key in general should be used to store registry key settings. Combines calls to GetRegistrySoftwareBase(), GetCompanyName(). This is useful when we need to access registry settings for other Autodesk applications. Note: Tailing backslash is not appended.

Returns:

base-key in this format: "SOFTWARE\<Company Name>"

UtilExport const MCHAR* UtilityInterface::GetRegistrySoftwareBase

(

)

Search for all occurrences

Returns the software base (i.e. SOFTWARE - should be static from release to release.)

Returns the software base (i.e. SOFTWARE - should be static from release to release.)

Returns:

Returns the software base (i.e. SOFTWARE - should be static from release to release.)

UtilExport const MCHAR* UtilityInterface::GetCompanyName

(

)

Search for all occurrences

Returns the company name (i.e. Autodesk). Mainly for branding purposes.

Returns:

Returns the company name (i.e. Autodesk). Mainly for branding purposes.

UtilExport const MCHAR* UtilityInterface::GetProductName

(

)

Search for all occurrences

Returns the product name (i.e. 3dsmax).

Returns:

Returns the product name (i.e. 3dsmax).

UtilExport EProductID UtilityInterface::GetProductID

(

)

Search for all occurrences

Allows to identify the product based on an identifier.

Plug-ins may decide to customize their look and feel or behaviour based on the product they are running in, in order to enhance the user experience they offer.

UtilExport const MCHAR* UtilityInterface::GetCurrentVersion

(

)

Search for all occurrences

Returns the current release-number (major, minor release: #.#).

Returns:

Returns the current release-number (major, minor release: #.#)

UtilExport bool UtilityInterface::GetBoolEnvironmentVariable	(	const MCHAR *	pEnvVarName,
		bool	defaultVal
	)

Search for all occurrences

Returns the true/false value of an environment variable.

Returns the true/false value of a specified environment variable, or the specified default value if the environment variable does not exist or the first character of its value is not one of "yYtT1" (true) or "nNfF0" (false)

Parameters:

[in]	pEnvVarName	Pointer to a null-terminated string that specifies the name of the environment variable
[in]	defaultVal	The default value used if the environment variable is not present, or doesn't contain a valid value

Returns:

Returns the true/false value of the environment variable or default

UtilExport void UtilityInterface::DisplayOutOfMemoryWarning

(

)

Search for all occurrences

Display a warning telling the user the application is out of memory.

UtilExport bool UtilityInterface::DisplayOutOfMemoryWarning

(

MCHAR *

message

)

Search for all occurrences

Displays a warning telling the user the application is out of memory.

Overloaded method that displays an extra message, and returns a value indicating if the user doesn't want to see this message again.

Parameters:

message

- An additional message

Returns:

- true if the user checked that they don't want to show this warning, false otherwise.