3dsmaxdlport.h File Reference

#include "utilexp.h"
#include "strbasic.h"
#include "BuildWarnings.h"
#include <wtypes.h>
#include <cmath>
#include <cstdlib>

Macros
#define	DL_STDEXT   stdext
#define	DL_NON_RTTI_OBJECT   std::__non_rtti_object
#define	DL_TYPENAME_OUTSIDE_TEMPLATE   typename

Typedefs
typedef INT_PTR(CALLBACK *	DL_NOTQUITE_WNDPROC) (HWND, UINT, WPARAM, LPARAM)

Enumerations
enum	{ FNV1_32_INIT = 0x811c9dc5 , FNV_32_PRIME = 0x01000193 }

Functions
template<typename DataPtr>
DataPtr	DLGetWindowLongPtr (HWND hWnd, int n=GWLP_USERDATA, DataPtr=NULL)
template<typename DataPtr>
DataPtr	DLGetWindowLongPtrA (HWND hWnd, int n=GWLP_USERDATA)
template<typename DataPtr>
DataPtr	DLGetWindowLongPtrW (HWND hWnd, int n=GWLP_USERDATA)
template<typename DataPtr>
DataPtr	DLGetWindowLongPtr (HWND hWnd, DataPtr *pPtr, int n=GWLP_USERDATA)
template<>
bool	DLGetWindowLongPtr (HWND hWnd, int n, bool)
WNDPROC	DLGetWindowProc (HWND hWnd)
WNDPROC	DLGetWindowProcA (HWND hWnd)
WNDPROC	DLGetWindowProcW (HWND hWnd)
HINSTANCE	DLGetWindowInstance (HWND hWnd)
template<typename Type>
Type	DLSetWindowLongPtr (HWND hWnd, Type ptr, int n=GWLP_USERDATA)
template<>
bool	DLSetWindowLongPtr (HWND hWnd, bool bo, int n)
WNDPROC	DLSetWindowLongPtr (HWND hWnd, WNDPROC pfn)
WNDPROC	DLSetWindowProc (HWND hWnd, WNDPROC pfn)
template<typename DataPtr>
DataPtr	DLGetClassLongPtr (HWND hWnd, int n, DataPtr=NULL)
template<typename DataPtr>
DataPtr	DLGetClassLongPtrA (HWND hWnd, int n)
template<typename DataPtr>
DataPtr	DLGetClassLongPtrW (HWND hWnd, int n)
template<typename DataPtr>
DataPtr	DLGetClassLongPtr (HWND hWnd, DataPtr *pPtr, int n)
template<>
bool	DLGetClassLongPtr (HWND hWnd, int n, bool)
WNDPROC	DLGetClassWindowProc (HWND hWnd)
WNDPROC	DLGetClassWindowProcA (HWND hWnd)
WNDPROC	DLGetClassWindowProcW (HWND hWnd)
template<typename Type>
Type	DLSetClassLongPtr (HWND hWnd, Type ptr, int n)
template<>
bool	DLSetClassLongPtr (HWND hWnd, bool bo, int n)
template<typename Type>
Type	DLSetClassLongPtrA (HWND hWnd, Type ptr, int n)
template<typename Type>
Type	DLSetClassLongPtrW (HWND hWnd, Type ptr, int n)
WNDPROC	DLSetClassWindowProc (HWND hWnd, WNDPROC pfn)
WNDPROC	DLSetClassWindowProcA (HWND hWnd, WNDPROC pfn)
WNDPROC	DLSetClassWindowProcW (HWND hWnd, WNDPROC pfn)
UtilExport LONG	DLRegSetString (HKEY key, const MCHAR *data, const MCHAR *name=NULL)
	Wrapper around the windows function RegSetValueEx.
UtilExport LONG	DLRegSetDWord (HKEY key, DWORD data, const MCHAR *name=NULL)
	Wrapper around the windows function RegSetValueEx for DWORD data.
template<typename BlobType>
LONG	DLRegSetBlob (HKEY key, const BlobType *lpbValue, DWORD n, LPCMSTR lpValueName=NULL)
UtilExport bool	GetQtTextExtent (const MCHAR *text, SIZE &extent)
	Calculates the text extents using Qt.
UtilExport BOOL	DLGetTextExtent (HDC hDC, const MCHAR *text, LPSIZE lpExtent, bool removeUIScaling=false, bool useQtTextWidth=true)
UtilExport BOOL	DLGetTextExtent (HDC hDC, const MCHAR *text, size_t len, LPSIZE lpExtent, bool removeUIScaling=false, bool useQtTextWidth=true)
UtilExport BOOL	DLTextOut (HDC hDC, int x, int y, const MCHAR *text)
UtilExport BOOL	DLTextOut (HDC hDC, int x, int y, const MCHAR *text, size_t len)
UtilExport LONG	DLTabbedTextOut (HDC hDC, int x, int y, const MCHAR *text, int nTabs, const INT *pTabPositions, int nTabOrigin)
UtilExport int	DLDrawText (HDC hDC, const MCHAR *lpString, LPRECT lpRect, UINT uFormat)
UtilExport int	DLDrawText (HDC hDC, const MCHAR *lpString, size_t len, LPRECT lpRect, UINT uFormat)
int	DLGetSystemMetrics (int nIndex)
	Wrapper around the windows function GetSystemMetrics.
WORD	PointerHiPart (ULONG_PTR ptr)
WORD	PointerLoPart (ULONG_PTR ptr)
WORD	PointerHiPart (LONG_PTR ptr)
WORD	PointerLoPart (LONG_PTR ptr)
WORD	PointerHiPart (void *ptr)
WORD	PointerLoPart (void *ptr)
unsigned int	fnv_32_buf (const void *buf, int len, unsigned int hval)
template<typename T>
unsigned int	DLObjectHash (T &t, int HashTableSize=0)
unsigned int	DLPointerHash (const void *pv, int HashTableSize=0)
int	DL_abs (int n)
__int64	DL_abs (__int64 n)
float	DL_abs (float f)
double	DL_abs (double f)
long double	DL_abs (long double f)

Macro Definition Documentation

DL_STDEXT

#define DL_STDEXT   stdext

DL_NON_RTTI_OBJECT

#define DL_NON_RTTI_OBJECT   std::__non_rtti_object

DL_TYPENAME_OUTSIDE_TEMPLATE

#define DL_TYPENAME_OUTSIDE_TEMPLATE   typename

Typedef Documentation

DL_NOTQUITE_WNDPROC

typedef INT_PTR(CALLBACK * DL_NOTQUITE_WNDPROC) (HWND, UINT, WPARAM, LPARAM)

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
FNV1_32_INIT
FNV_32_PRIME

{
   FNV1_32_INIT = 0x811c9dc5,
   FNV_32_PRIME = 0x01000193
};

Function Documentation

DLGetWindowLongPtr() [1/3]

template<typename DataPtr>

DataPtr DLGetWindowLongPtr	(	HWND	hWnd,
		int	n = GWLP_USERDATA,
		DataPtr	= NULL )

{
   return (DataPtr)(static_cast<LONG_PTR>(::GetWindowLongPtr(hWnd, n)));
}

DLGetWindowLongPtrA()

template<typename DataPtr>

DataPtr DLGetWindowLongPtrA	(	HWND	hWnd,
		int	n = GWLP_USERDATA )

{
    return (DataPtr)(static_cast<LONG_PTR>(::GetWindowLongPtrA(hWnd, n)));
}

DLGetWindowLongPtrW()

template<typename DataPtr>

DataPtr DLGetWindowLongPtrW	(	HWND	hWnd,
		int	n = GWLP_USERDATA )

{
    return (DataPtr)(static_cast<LONG_PTR>(::GetWindowLongPtrW(hWnd, n)));
}

DLGetWindowLongPtr() [2/3]

template<typename DataPtr>

DataPtr DLGetWindowLongPtr	(	HWND	hWnd,
		DataPtr *	pPtr,
		int	n = GWLP_USERDATA )

{
   *pPtr = DLGetWindowLongPtr<DataPtr>(hWnd, n);
 
   return *pPtr;
}

DLGetWindowLongPtr() [3/3]

template<>

bool DLGetWindowLongPtr ( HWND hWnd, int n, bool  )

inline

{
   // Specialize for bool so we can quietly deal 
   // warning C4800: 'LONG_PTR' : forcing value to bool 'true' or 'false' (performance warning)
   return ::GetWindowLongPtr(hWnd, n) != 0;
}

DLGetWindowProc()

WNDPROC DLGetWindowProc ( HWND hWnd )

inline

{
   return DLGetWindowLongPtr<WNDPROC>(hWnd, GWLP_WNDPROC);
}

DLGetWindowProcA()

WNDPROC DLGetWindowProcA ( HWND hWnd )

inline

{
    return DLGetWindowLongPtrA<WNDPROC>(hWnd, GWLP_WNDPROC);
}

DLGetWindowProcW()

WNDPROC DLGetWindowProcW ( HWND hWnd )

inline

{
    return DLGetWindowLongPtrW<WNDPROC>(hWnd, GWLP_WNDPROC);
}

DLGetWindowInstance()

HINSTANCE DLGetWindowInstance ( HWND hWnd )

inline

{
   return DLGetWindowLongPtr<HINSTANCE>(hWnd, GWLP_HINSTANCE);
}

DLSetWindowLongPtr() [1/3]

template<typename Type>

Type DLSetWindowLongPtr ( HWND hWnd, Type ptr, int n = GWLP_USERDATA )

inline

{
#if !defined( _WIN64 )
   // SetWindowLongPtr() maps to SetWindowLong() in 32 bit land; react accordingly to keep
   // the compiler happy, even with /Wp64.
   return (Type)(static_cast<LONG_PTR>(::SetWindowLongPtr(hWnd, n, (LONG)((LONG_PTR)(ptr)))));
#else
   return (Type)(static_cast<LONG_PTR>(::SetWindowLongPtr(hWnd, n, (LONG_PTR)(ptr))));
#endif
}

DLSetWindowLongPtr() [2/3]

template<>

bool DLSetWindowLongPtr ( HWND hWnd, bool bo, int n )

inline

{
   // Specialize for bool so we can quietly deal 
   // warning C4800: 'LONG_PTR' : forcing value to bool 'true' or 'false' (performance warning)
   return ::SetWindowLongPtr(hWnd, n, bo) != 0;
}

DLSetWindowLongPtr() [3/3]

WNDPROC DLSetWindowLongPtr ( HWND hWnd, WNDPROC pfn )

inline

{
   return DLSetWindowLongPtr<WNDPROC>(hWnd, pfn, GWLP_WNDPROC);
}

DLSetWindowProc()

WNDPROC DLSetWindowProc ( HWND hWnd, WNDPROC pfn )

inline

{
   return DLSetWindowLongPtr<WNDPROC>(hWnd, pfn, GWLP_WNDPROC);
}

DLGetClassLongPtr() [1/3]

template<typename DataPtr>

DataPtr DLGetClassLongPtr	(	HWND	hWnd,
		int	n,
		DataPtr	= NULL )

{
   return (DataPtr)(static_cast<LONG_PTR>(::GetClassLongPtr(hWnd, n)));
}

DLGetClassLongPtrA()

template<typename DataPtr>

DataPtr DLGetClassLongPtrA	(	HWND	hWnd,
		int	n )

{
    return (DataPtr)(static_cast<LONG_PTR>(::GetClassLongPtrA(hWnd, n)));
}

DLGetClassLongPtrW()

template<typename DataPtr>

DataPtr DLGetClassLongPtrW	(	HWND	hWnd,
		int	n )

{
    return (DataPtr)(static_cast<LONG_PTR>(::GetClassLongPtrW(hWnd, n)));
}

DLGetClassLongPtr() [2/3]

template<typename DataPtr>

DataPtr DLGetClassLongPtr	(	HWND	hWnd,
		DataPtr *	pPtr,
		int	n )

{
   *pPtr = DLGetClassLongPtr<DataPtr>(hWnd, n);
 
   return *pPtr;
}

DLGetClassLongPtr() [3/3]

template<>

bool DLGetClassLongPtr ( HWND hWnd, int n, bool  )

inline

{
   return ::GetClassLongPtr(hWnd, n) != 0;
}

DLGetClassWindowProc()

WNDPROC DLGetClassWindowProc ( HWND hWnd )

inline

{
   return DLGetClassLongPtr<WNDPROC>(hWnd, GCLP_WNDPROC);
}

DLGetClassWindowProcA()

WNDPROC DLGetClassWindowProcA ( HWND hWnd )

inline

{
    return DLGetClassLongPtrA<WNDPROC>(hWnd, GCLP_WNDPROC);
}

DLGetClassWindowProcW()

WNDPROC DLGetClassWindowProcW ( HWND hWnd )

inline

{
    return DLGetClassLongPtrW<WNDPROC>(hWnd, GCLP_WNDPROC);
}

DLSetClassLongPtr() [1/2]

template<typename Type>

Type DLSetClassLongPtr ( HWND hWnd, Type ptr, int n )

inline

{
#if !defined( _WIN64 )
   // SetClassLongPtr() maps to SetClassLong() in 32 bit land; react accordingly to keep
   // the compiler happy, even with /Wp64.
   return (Type)(static_cast<LONG_PTR>(::SetClassLongPtr(hWnd, n, (LONG)((LONG_PTR)(ptr)))));
#else
   return (Type)(static_cast<LONG_PTR>(::SetClassLongPtr(hWnd, n, (LONG_PTR)(ptr))));
#endif
}

DLSetClassLongPtr() [2/2]

template<>

bool DLSetClassLongPtr ( HWND hWnd, bool bo, int n )

inline

{
   // Specialize for bool so we can quietly deal 
   // warning C4800: 'LONG_PTR' : forcing value to bool 'true' or 'false' (performance warning)
   return ::SetClassLongPtr(hWnd, n, bo) != 0;
}

DLSetClassLongPtrA()

template<typename Type>

Type DLSetClassLongPtrA ( HWND hWnd, Type ptr, int n )

inline

{
#if !defined( _WIN64 )
    // SetClassLongPtr() maps to SetClassLong() in 32 bit land; react accordingly to keep
    // the compiler happy, even with /Wp64.
    return (Type)(static_cast<LONG_PTR>(::SetClassLongPtrA(hWnd, n, (LONG)((LONG_PTR)(ptr)))));
#else
    return (Type)(static_cast<LONG_PTR>(::SetClassLongPtrA(hWnd, n, (LONG_PTR)(ptr))));
#endif
}

DLSetClassLongPtrW()

template<typename Type>

Type DLSetClassLongPtrW ( HWND hWnd, Type ptr, int n )

inline

{
#if !defined( _WIN64 )
    // SetClassLongPtr() maps to SetClassLong() in 32 bit land; react accordingly to keep
    // the compiler happy, even with /Wp64.
    return (Type)(static_cast<LONG_PTR>(::SetClassLongPtrW(hWnd, n, (LONG)((LONG_PTR)(ptr)))));
#else
    return (Type)(static_cast<LONG_PTR>(::SetClassLongPtrW(hWnd, n, (LONG_PTR)(ptr))));
#endif
}

DLSetClassWindowProc()

WNDPROC DLSetClassWindowProc ( HWND hWnd, WNDPROC pfn )

inline

{
    return DLSetClassLongPtr<WNDPROC>(hWnd, pfn, GCLP_WNDPROC);
}

DLSetClassWindowProcA()

WNDPROC DLSetClassWindowProcA ( HWND hWnd, WNDPROC pfn )

inline

{
    return DLSetClassLongPtrA<WNDPROC>(hWnd, pfn, GCLP_WNDPROC);
}

DLSetClassWindowProcW()

WNDPROC DLSetClassWindowProcW ( HWND hWnd, WNDPROC pfn )

inline

{
    return DLSetClassLongPtrW<WNDPROC>(hWnd, pfn, GCLP_WNDPROC);
}

DLRegSetString()

UtilExport LONG DLRegSetString	(	HKEY	key,
		const MCHAR *	data,
		const MCHAR *	name = NULL )

Wrapper around the windows function RegSetValueEx.

Parameters

key	- The handle to an open registry key
data	- The actual data to be added to the registry
name	- The name of the registry key HKEY query; MSTR sub_key; sub_key.printf(_T("Software\\Autodesk\\3dsMax\\%d.0"), MAX_VERSION_MAJOR); LONG opened = ::RegOpenKeyEx(HKEY_CURRENT_USER, sub_key.data(), 0, KEY_ALL_ACCESS, &query); if (opened != ERROR_SUCCESS) return; LONG result = DLRegSetString(query, _T("TestValue"), _T("TestKey"));

DLRegSetDWord()

UtilExport LONG DLRegSetDWord	(	HKEY	key,
		DWORD	data,
		const MCHAR *	name = NULL )

Wrapper around the windows function RegSetValueEx for DWORD data.

Parameters

key	- The handle to an open registry key
data	- The actual data to be added to the registry
name	- The name of the registry key

DLRegSetBlob()

template<typename BlobType>

LONG DLRegSetBlob ( HKEY key, const BlobType * lpbValue, DWORD n, LPCMSTR lpValueName = NULL )

inline

{
   return ::RegSetValueEx(key, lpValueName, 0, REG_BINARY, 
                          reinterpret_cast<LPBYTE>(const_cast<BlobType*>(lpbValue)), 
                          n * sizeof(BlobType));
}

GetQtTextExtent()

UtilExport bool GetQtTextExtent	(	const MCHAR *	text,
		SIZE &	extent )

Calculates the text extents using Qt.

Parameters

[in]	text	- The text.
[out]	extent	- The text's extent as calculated via QFontMetricsF(qApp->font()).boundingRect({}, 0, text).

Returns

true if the text's extent was calculated (qApp exists, text not null).

DLGetTextExtent() [1/2]

UtilExport BOOL DLGetTextExtent	(	HDC	hDC,
		const MCHAR *	text,
		LPSIZE	lpExtent,
		bool	removeUIScaling = false,
		bool	useQtTextWidth = true )

DLGetTextExtent() [2/2]

UtilExport BOOL DLGetTextExtent	(	HDC	hDC,
		const MCHAR *	text,
		size_t	len,
		LPSIZE	lpExtent,
		bool	removeUIScaling = false,
		bool	useQtTextWidth = true )

DLTextOut() [1/2]

UtilExport BOOL DLTextOut	(	HDC	hDC,
		int	x,
		int	y,
		const MCHAR *	text )

DLTextOut() [2/2]

UtilExport BOOL DLTextOut	(	HDC	hDC,
		int	x,
		int	y,
		const MCHAR *	text,
		size_t	len )

DLTabbedTextOut()

UtilExport LONG DLTabbedTextOut	(	HDC	hDC,
		int	x,
		int	y,
		const MCHAR *	text,
		int	nTabs,
		const INT *	pTabPositions,
		int	nTabOrigin )

DLDrawText() [1/2]

UtilExport int DLDrawText	(	HDC	hDC,
		const MCHAR *	lpString,
		LPRECT	lpRect,
		UINT	uFormat )

DLDrawText() [2/2]

UtilExport int DLDrawText	(	HDC	hDC,
		const MCHAR *	lpString,
		size_t	len,
		LPRECT	lpRect,
		UINT	uFormat )

DLGetSystemMetrics()

int DLGetSystemMetrics ( int nIndex )

inline

Wrapper around the windows function GetSystemMetrics.

In Vista+ when running Aero, the value returned for SM_CXFRAME and SM_CYFRAME is incorrect in order to provide backwards compatibility with NT. To get the correct value, also need to add the value from SM_CXPADDEDBORDER. The implementation of this method automatically corrects the values returned for SM_CXFRAME and SM_CYFRAME. Note that SM_CXSIZEFRAME is the same index as SM_CXFRAME, and SM_CYSIZEFRAME as SM_CYFRAME;

Parameters

nIndex

- The system metric or configuration setting to be retrieved.

{
    int res = GetSystemMetrics(nIndex);
    static bool applyCorrection = true;
    if ( applyCorrection && (nIndex == SM_CXFRAME || nIndex == SM_CYFRAME))
        res += GetSystemMetrics(92); // SM_CXPADDEDBORDER == 92, defined only when _WIN32_WINNT >= 0x0600
    return res;
}

PointerHiPart() [1/3]

WORD PointerHiPart ( ULONG_PTR ptr )

inline

{
   return static_cast<WORD>(ptr >> 16);
}

PointerLoPart() [1/3]

WORD PointerLoPart ( ULONG_PTR ptr )

inline

{
   return static_cast<WORD>(ptr);
}

PointerHiPart() [2/3]

WORD PointerHiPart ( LONG_PTR ptr )

inline

{
   return static_cast<WORD>((ptr >> 16) & 0xffff);
}

PointerLoPart() [2/3]

WORD PointerLoPart ( LONG_PTR ptr )

inline

{
   return static_cast<WORD>(ptr & 0xffff);
}

PointerHiPart() [3/3]

WORD PointerHiPart ( void * ptr )

inline

{
   return PointerHiPart(reinterpret_cast<ULONG_PTR>(ptr));
}

PointerLoPart() [3/3]

WORD PointerLoPart ( void * ptr )

inline

{
   return PointerLoPart(reinterpret_cast<ULONG_PTR>(ptr));
}

fnv_32_buf()

unsigned int fnv_32_buf ( const void * buf, int len, unsigned int hval )

inline

{
   const unsigned char *bp = (const unsigned char *)buf; /* start of buffer */
   const unsigned char *be = bp + len;                   /* beyond end of buffer */
 
   /*
    * FNV-1 hash each octet in the buffer
    */
   while (bp < be) 
   {
      /* multiply by the 32 bit FNV magic prime mod 2^32 */
      hval *= FNV_32_PRIME;
 
      /* xor the bottom with the current octet */
      hval ^= (unsigned int)*bp++;
   }
 
   /* return our new hash value */
   return hval;
}

DLObjectHash()

template<typename T>

unsigned int DLObjectHash ( T & t, int HashTableSize = 0 )

inline

{
   // Since we're always hashing single objects, we hash using the 'init value';
   // we'd have to carry it over if we were hashing all fields in a structure, for
   // instance.
   // You should never never never never attempt to hash a structure by passing its
   // pointer, since you'd end up hashing the padding bytes as well, which are definitely
   // not going to be preserved.
   unsigned int hash = fnv_32_buf(&t, sizeof(t), (unsigned int)FNV1_32_INIT);
 
   return HashTableSize ? hash % HashTableSize : hash;
}

DLPointerHash()

unsigned int DLPointerHash ( const void * pv, int HashTableSize = 0 )

inline

{
   return DLObjectHash(pv, HashTableSize);
}

DL_abs() [1/5]

int DL_abs ( int n )

inline

{ return std::abs(n); }

DL_abs() [2/5]

__int64 DL_abs ( __int64 n )

inline

{ return (n < 0) ? -n : n; }

DL_abs() [3/5]

float DL_abs ( float f )

inline

{ return std::fabsf(f); }

DL_abs() [4/5]

double DL_abs ( double f )

inline

{ return std::fabs(f); }

DL_abs() [5/5]

long double DL_abs ( long double f )

inline

{ return std::fabsl(f); }