MaxSDK::TranslationSupport Namespace Reference

MAXScript scripts are typically written in English, but when MAXScript accesses names from TrackView nodes only localized names are available. More...

Enumerations
enum	ResolutionContext { kTrackViewNodes , kCount }
	The property name resolution context where localized \ English string translation lookup is occurring. More...

Functions
CoreExport bool	RegisterTranslation (ResolutionContext context, const MCHAR *localizedString, const MCHAR *nonLocalizedString)
	Specifies translation between a localized and non-localized (English) string pair for when MAXScript is performing property resolution.
CoreExport bool	GetLocalizedStrings (ResolutionContext context, const MCHAR *nonLocalizedString, Tab< const MCHAR * > &localizedStrings)
	Retrieves localized translations for a non-localized (English) string.
CoreExport bool	GetNonLocalizedStrings (ResolutionContext context, const MCHAR *localizedString, Tab< const MCHAR * > &nonLocalizedStrings)
	Retrieves non-localized (English) translations for a localized string.

Detailed Description

MAXScript scripts are typically written in English, but when MAXScript accesses names from TrackView nodes only localized names are available.

By specifying localized and English string pairs using the RegisterTranslation method, MAXScript is able to retrieve the English name corresponding to a localized name to see if it matches the property name or SubAnim name specified by a script. Code that operates on TrackView nodes via ITrackViewNode::AddNode or ITrackViewNode::AddController should register via RegisterTranslation the English name corresponding to the localized name specified in these methods. TrackView nodes persist their names to the scene file, so in order to ensure that the translations are present when loading the scene file, the translations should be registered when the dll is loaded.

For example, if have the following code:

node->AddNode(vp, GetString(IDS_RB_VIDEOPOST), VIDEO_POST_TVNODE_CLASS_ID);
vp->AddController(cont, GetString(IDS_RB_FLOAT), cont->ClassID());

The following would be specified:

void RegisterTranslations()
{
    MaxSDK::TranslationSupport::RegisterTranslation(MaxSDK::TranslationSupport::kTrackViewNodes, 
        GetString(IDS_RB_VIDEOPOST), _T("Video Post"));
    MaxSDK::TranslationSupport::RegisterTranslation(MaxSDK::TranslationSupport::kTrackViewNodes, 
        GetString(IDS_RB_FLOAT), _T("Float"));
    }

And then RegisterTranslations() would be called from the DllMain function handling of DLL_PROCESS_ATTACH. For example:

BOOL WINAPI DllMain(HINSTANCE hinstDLL,ULONG fdwReason,LPVOID lpvReserved)
{
    switch( fdwReason )
    {
        case DLL_PROCESS_ATTACH:
        MaxSDK::Util::UseLanguagePackLocale();
        hInstance = hinstDLL;
        DisableThreadLibraryCalls(hInstance);
        RegisterTranslations();
        break;
    }
    return (TRUE);
}

Enumeration Type Documentation

ResolutionContext

enum ResolutionContext

The property name resolution context where localized \ English string translation lookup is occurring.

Enumerator
kTrackViewNodes
kCount

        {
            kTrackViewNodes,            //< Resolving Trackview Node \ Controller names
            kCount                      //< the number of contexts
        };

Function Documentation

RegisterTranslation()

CoreExport bool RegisterTranslation	(	ResolutionContext	context,
		const MCHAR *	localizedString,
		const MCHAR *	nonLocalizedString
	)

Specifies translation between a localized and non-localized (English) string pair for when MAXScript is performing property resolution.

Parameters

[in]	context	- The property name resolution context where this translation will be used
[in]	localizedString	- the localized string
[in]	nonLocalizedString	- the non-localized (English) string

Returns

- always returns true. A return value is specified so that this method can be used as a static variable initializer, registering translation once. /note The strings are stored in lower case as name resolution in MAXScript is case insensitive when dealing with 3dsMax objects. /note If the localized and non-localized strings are case-insensitive equivalent, the strings are not registered. /note Unique localized \ non-localized string pairs will only be registered once.

GetLocalizedStrings()

CoreExport bool GetLocalizedStrings	(	ResolutionContext	context,
		const MCHAR *	nonLocalizedString,
		Tab< const MCHAR * > &	localizedStrings
	)

Retrieves localized translations for a non-localized (English) string.

Parameters

[in]	context	- The property name resolution context
[in]	nonLocalizedString	- the non-localized (English) string
[out]	localizedStrings	- an array of the localized strings

Returns

- returns true if localized strings were found, false otherwise. /note This method would not normally be used by 3rd party developers.

GetNonLocalizedStrings()

CoreExport bool GetNonLocalizedStrings	(	ResolutionContext	context,
		const MCHAR *	localizedString,
		Tab< const MCHAR * > &	nonLocalizedStrings
	)

Retrieves non-localized (English) translations for a localized string.

Parameters

[in]	context	- The property name resolution context
[in]	localizedString	- the localized string
[out]	nonLocalizedStrings	- an array of the non-localized (English) strings

Returns

- returns true if non-localized strings were found, false otherwise.

- returns true if localized strings were found, false otherwise. /note This method would not normally be used by 3rd party developers.