Detailed Description

Utility classes useful for developing a You.i Engine application.

The utility classes in You.i Engine provide functionality which will be useful when developing a You.i Engine application.

Focus

10-foot platforms, which do not support touch or cursor input, require interaction through directional input. The focus system in You.i Engine enables a user to interact with the application through directional input. The focus system is built into the CYISceneManager and CYISceneNode. CYIFocus contained in utilities provides focus information which may be useful when implementing focus in a custom view.

Time

Utilities include various time related classes which are used for determining the current time as well as date time manipulation. CYIDateTime is a container class which can be used to represent time. CYIDateTime objects can be created with epoch time as well as an ISO 8061 formatted string. The class provides various accessors for parts of the date as well as mutators for modifying the date object.

The CYITime class provides information about the current frame time of the application and enables a user to register a listener for updates on the frame time. CYITime is used to provide the CYITimer utility, this utility can be used to handle an event which must occur after a period of time has passed.

Localization

Localization enables an application's text to be translated to different languages. You.i Engine supports localization of text contained in After Effects compositions as well as text located in source code. The CYILocale class is a container for a specific locale and can be populated using the system locale obtained from CYILocaleBridge contained in Platform.

The translation system is comprised of CYITranslation and CYITranslator. CYITranslation is the entry point for translation and CYITranslator is the is responsible for the translation of text to a specific language. The script runGetText.rb is a tool packaged with the engine and is used to generate a file containing all text instances which require translation. Text in After Effects that is not configured as dynamic text and strings wrapped in YiTranslate in source code will be added to this file. These strings can then be translated and compiled into a binary which You.i Engine loads to carry-out the localization process. See runGetText.rb for a detailed description of the generation process and the localization sample for an example of the end-to-end localization process.

Strings

You.i Engine provides the CYIString class that is a cross-platform string implementation which is used throughout You.i Engine and simplifies the use of strings. This string implementation provides common string manipulation functionality as well as conversion from platform specific string formats into CYIString.

Run-Time Type Information (RTTI)

Run-Time Type Information (RTTI) enables You.i Engine views to be instanced at import time based on the class information exported from After Effects. All CYISceneView subclasses must contain RTTI type information. RTTI also allows for downcasting types at runtime. See YiRtti.h for details and code snippets.

Files
file	YiRtti.h
	This file contains the classes and macros used to implement RTTI in You.i Engine.

Namespaces
	yi::deprecated
	Deprecated classes.

Classes
class	YiRootViewController
	The view controller under which all You.i Engine views are located. More...

class	CYIDevPanel
	A class used to manipulate developer utilities. More...

class	CYIDevWidget
	The base class for all dev widgets. More...

class	CYIDevWidgetWithText
	A dev widget used to display text to the user. More...

class	CYIDevWidgetWithView
	A dev widget that displays a scene view when activated. More...

class	CYISignalWidget
	A dev widget that calls a signal when activated. More...

class	CYIAny
	A class that holds instances of any type that is copy-constructible. More...

class	CYIApp
	The base class for all applications. More...

class	CYIAppContext

class	CYIFramework
	CYIFramework is a singleton class used to acquire global instances of a number of classes. More...

class	CYIFrameworkConfiguration
	CYIFrameworkConfiguration is used to specify configuration settings for the CYIFramework class. More...

struct	YI_POINT

struct	YI_POINT2D

struct	YI_RECT

struct	YI_RECT_REL

struct	YI_FLOAT_RECT

struct	YI_FLOAT_RECT_REL

class	YI_SCREEN_INFO

class	CYIScreen

class	CYIVersion
	CYIVersion is a data structure that represents semantic versioning. More...

class	CYIGPUExportUtilities
	GPU utilities. More...

class	CYISceneNodeBuilder

class	CYIAutoProfiler
	An RAII class that starts a profiler when created, and stops it when destroyed. More...

class	CYIBundle
	CYIBundle represents a collection of key-value pairs. More...

class	CYIColor
	A class used to represent a color value. More...

class	CYINamedColors

class	CYIConcurrentDeque< YI_DATA >
	A simple, thread safe deque. More...

class	CYIConcurrentQueue< YI_DATA >
	A simple, thread safe queue. More...

class	CYICondition
	Represents a boolean condition. More...

class	CYIConditionEvaluator
	Evaluates when CYICondition objects have been set, and notifies users. More...

class	CYICryptoUtility
	The CYICryptoUtility class contains utilities that are cryptographic in nature. More...

class	CYICustomMarkupTagsProvider

class	CYIDateTime
	Utility class that requires a string as per the following format: http://en.wikipedia.org/wiki/ISO_8601 to construct an instance and provides some commmonly used parts like year, month, hour etc. in different data types and formats. All dates are in the local timezone unless otherwise specified. More...

class	CYIDir
	This class provides functionality for working with directories. More...

class	CYIFile
	This class provides functionality for working with files. More...

class	CYIFileWatcher
	Monitor one or more directories for changes in their files. More...

class	CYIFocus
	A collection focus-finding utilities. More...

class	CYIFocusSearchOptions
	A class containing focus search options. More...

class	CYIFontUtilities

class	CYIHelper

class	CYIKeyValuePairConverter

class	CYILayoutUtility
	A utility class that helps retrieving attachement positions relative to an object. More...

class	CYILazy< YI_CLASS >
	CYILazy is a thread-safe lazy initializer of a class. The instance pointer remains null until CYILazy::Get() is called, which will trigger a thread-safe initialization of the instance. Also, a CYILazy::TryGet() is available, which will return the actual value while not instantiating, providing a convenient way to test for nullptr in the event that the user does not want the instantiation to occur. More...

class	CYILocale
	A class representing a locale. More...

class	CYIMatrixUtilities

struct	memsource_struct

class	CYIMOTranslator
	A translator object used for parsing and indexing localisation strings found in ".mo" binary files. These objects are available through the CYITranslation interface and should be primarily loaded through the CYIAssetLoader, which will provide a CYIAssetTranslation object. More...

class	CYIObjectPrinter
	A class used to get the string representation of an object or of a complex type. More...

class	CYIParsingError
	A class to store errors in the parsing of encoded data, such as JSON or XML. More...

class	CYIPersistentStore

class	CYIPreferences
	Property management class using CYIString names and values. More...

class	CYIPriorityQueue< YI_PRIORITY_QUEUE_ITEM, YI_PRIORITY_QUEUE_ALLOCATOR >
	A container class which maintains a queue of items within defined YI_PRIORITY_QUEUE_PRIORITY priorities. More...

class	CYIProfileData
	This class is used as a profiling or a measurement tool for recurring activities. By marking the beginning and the end of a particular activity, various statistics can be queried from this class. More...

class	CYIProfiler
	– CYIProfiler More...

class	CYIRandom

class	CYIRapidJSONUtility
	A front-end utility class aimed to simplify the use of RapidJSON tools. More...

class	CYIRuntimeTypeInfo
	The abstract runtime representation of a C++ type. More...

class	CYIRuntimeTypeInfoTyped< CLASS, BASE1, BASE2, BASE3 >
	The runtime representation of a C++ type. More...

class	CYIRTTIRegistry
	A registry of all known RTTI types. More...

class	RTTISampleClass
	This is a sample class to document the RTTI functions inserted into classes by the YI_TYPE_BASES(...) macro. More...

class	CYISceneNodeUtility

class	CYIString
	Container class for Unicode strings. Conceptually, a CYIString object is a sequence of Unicode characters. More...

class	CYIStringCXUtilities

class	CYICaseInsensitiveLessThanComparator

class	CYICaseInsensitiveEqualsPredicate

class	CYITextMarkupParser

class	CYITime
	global class used to notify the system of time updates More...

class	CYITimeConversion

class	CYITimer
	A low-precision timer driven by the update loop. More...

class	CYITranslation
	Provides string localization. More...

class	CYITranslator

struct	YI_REMOVE_REFERENCE< YI_TYPE >

struct	YI_REMOVE_CONST< YI_TYPE >

struct	YI_REMOVE_VOLATILE< YI_TYPE >

struct	YI_REMOVE_CONST_VOLATILE< YI_TYPE >

struct	YI_REMOVE_POINTER< YI_TYPE >

struct	YiIsSameType< FIRST, SECOND >

struct	YiIntegralConstant< Type, templateValue >

struct	YiIsVoid< Type >

struct	YiIsIntegral< Type >

struct	YiIsFloatingPoint< Type >

class	YiIsBaseOf< BASE, DERIVED >

struct	YiHasOutputStreamOperator< STREAM, TYPE >

struct	YiEnableIf< CONDITION, TYPE >

struct	YiMakeIndexSequence< S >

struct	YiDependentFalse< T >

struct	YiFunctionArity< F >

class	CYIYouIMarkupParser

Macros
#define	YI_NULL nullptr

#define	YI_ENV_32 1

#define	strcat(dst, src) YI_ERROR("strcat: Does not check for buffer overflows when concatenating to destination (CWE-120). Consider using YI_STRNCAT, strcat_s, or strlcat (warning, YI_STRNCAT is easily misused).")

#define	strcpy(dst, src) YI_ERROR("strcpy: Does not check for buffer overflows when copying to destination (CWE-120). Consider using YI_STRNCPY, strcpy_s, or strlcpy (warning, YI_STRNCAT is easily misused).")

#define	sprintf(str, fmt, ...) YI_ERROR("sprintf: Does not check for buffer overflows (CWE-120). Use YI_SNPRINTF, YI_VSNPRINTF, or sprintf_s.")

#define	gets(str) YI_ERROR("gets: Does not check for buffer overflows (CWE-120, CWE-20). Use fgets() instead.")

#define	wcscpy(dst, src) YI_ERROR("wcscpy: Does not check for buffer overflows when copying to destination (CWE-120). Consider using a function version that stops copying at the end of the buffer.")

#define	wcscat(dst, src) YI_ERROR("wcscat: Does not check for buffer overflows when concatenating to destination (CWE-120).")

#define	swprintf(str, fmt, ...) YI_ERROR("swprintf: Does not check for buffer overflows (CWE-120). Use YI_SNPRINTF, YI_VSNPRINTF, or sprintf_s.")

#define	YI_DISABLE_URL_SECURITY

#define	YI_WTEXT(quote) (const wchar_t *)L##quote

#define	YI_TEXT(quote) (const char *)quote

#define	YI_TEXT16(quote) (const char16_t *)L##quote

#define	YI_TEXT32(quote) (const char32_t *)L##quote

#define	YI_INLINE

#define	YI_EXTERNINLINE

#define	YI_SEEK_SET 0

#define	YI_SEEK_END 1

#define	YI_SEEK_CUR 2

#define	YI_MAX_PATH 260

#define	YI_MAX_BUFFER 1024

#define	YI_MIN(a, b) (((a) < (b)) ? (a) : (b))

#define	YI_MAX(a, b) (((a) < (b)) ? (b) : (a))

#define	YI_FLOAT_EQUAL(a, b) ((a) >= ((b) - FLT_EPSILON) && (a) <= ((b) + FLT_EPSILON))

#define	YI_UNUSED(param) (void)(param)

#define	YI_UNUSED_ATTRIBUTE __attribute__((unused))

#define	YI_FORCE_INLINE inline

#define	YI_FUNCTION_SPECIALIZATION_FULLY_SUPPORTED

#define	YI_DISALLOW_COPY_AND_ASSIGN(TypeName)
	Delete the copy constructor and assignment operator (and consequently the move constructor as well) More...

#define	YI_DEFAULT_MOVE_AND_COPY(TypeName)
	Explicitly define the copy constructor and move constructor, as well as assignment operators for each. More...

#define	YI_DEFAULT_MOVE_NO_COPY(TypeName)
	Explicitly define the default move constructor and assignment operator, but disallow copying. More...

#define	YI_DEFAULT_MOVE(TypeName)
	Explicitly define the default move constructor and assignment operator. More...

#define	YI_DEFAULT_COPY(TypeName)
	Explicitly define the default copy constructor and assignment operator. More...

#define	YI_REMOVE_CONSTANT_CONDITION(x) do { x } while ((void)0, 0)
	This is a C++ trick for avoiding constant condition warnings, particularly in Microsoft compilers. More...

#define	YI_LITTLE_ENDIAN_16(a) (a)

#define	YI_LITTLE_ENDIAN_24(a) (a)

#define	YI_LITTLE_ENDIAN_32(a) (a)

#define	YI_LITTLE_ENDIAN_64(a) (a)

#define	YI_SYSTEM_FREE(a) free(a)

#define	YI_SYSTEM_MALLOC(a) malloc(a)

#define	YI_SYSTEM_REALLOC(a, b) realloc(a, b)

#define	YI_MEMCMP(a, b, c) memcmp(a, b, c)

#define	YI_MEMMOVE(a, b, c) memmove(a, b, c)

#define	YI_MEMCOPY(a, b, c) memcpy(a, b, c)

#define	YI_MEMSET(a, b, c) memset(a, b, c)

#define	YI_STRCAT(a, b) strcat(a, b)

#define	YI_STRCHR(a, b) strchr(a, b)

#define	YI_STRCMP(a, b) strcmp(a, b)

#define	YI_STRCPY(a, b) strcpy(a, b)

#define	YI_STRUP(a) strdup(a)

#define	YI_STRLEN(a) strlen(a)

#define	YI_STRREV(a) STRREV(a)

#define	YI_STRNCMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNICMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNCAT(a, b, c) strncat(a, b, c)

#define	YI_STRNCPY(a, b, c) strncpy(a, b, c)

#define	YI_STRRCHR(a, b) strrchr(a, b)

#define	YI_STRTOUL(a, b, c) strtoul(a, b, c)

#define	YI_VSNPRINTF(a, b, c, d) vsnprintf(a, b, c, d)

#define	YI_STRICMP(a, b) strcmp(a, b)

#define	YI_SPRINTF sprintf

#define	YI_SNPRINTF snprintf

#define	YI_ATOI(a) atoi(a)

#define	YI_ATOF(a) atof(a)

#define	YI_WCSCPY(a, b) wcscpy( a, b)

#define	YI_WCSNCPY(a, b, c) wcsncpy( a, b, (size_t)c)

#define	YI_WCSCAT(a, b) wcscat( a, b)

#define	YI_WCSLEN(a) (int32_t) wcslen(a)

#define	YI_WCSREV(a) WCSREV( a)

#define	YI_WCSCMP(a, b) wcscmp( a, b)

#define	YI_WCSNCMP(a, b, c) wcsncmp( a, b, (size_t)c)

#define	YI_WCSICMP(a, b) WCSICMP( a, b)

#define	YI_WCSNICMP(a, b, c) WCSNICMP(a, b, (size_t)c)

#define	YI_WCSNCAT(a, b, c) wcsncat(a, b, (size_t)c)

#define	YI_SLEEP(x) usleep((x)*1000)

#define	YI_USLEEP(x) usleep(x)

#define	YI_FILE FILE

#define	YI_FREAD (int32_t) fread

#define	YI_FWRITE fwrite

#define	YI_FGETC fgetc

#define	YI_FPUTC fputc

#define	YI_KEYCODE_HOME_BUTTON 0x00000003

#define	YI_KEYCODE_BACK_BUTTON 0x00000004

#define	YI_HAS_VIRTUAL_KEYBOARD

#define	YI_SYSTEM_FREE(a) free(a)

#define	YI_SYSTEM_MALLOC(a) malloc(a)

#define	YI_SYSTEM_REALLOC(a, b) realloc(a, b)

#define	YI_MEMCMP(a, b, c) memcmp(a, b, c)

#define	YI_MEMMOVE(a, b, c) memmove(a, b, c)

#define	YI_MEMCOPY(a, b, c) memcpy(a, b, c)

#define	YI_MEMSET(a, b, c) memset(a, b, c)

#define	YI_STRCAT(a, b) strcat(a, b)

#define	YI_STRCHR(a, b) strchr(a, b)

#define	YI_STRCMP(a, b) strcmp(a, b)

#define	YI_STRCPY(a, b) strcpy(a, b)

#define	YI_STRLEN(a) strlen(a)

#define	YI_STRREV(a) STRREV(a)

#define	YI_STRNCMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNICMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNCAT(a, b, c) strncat(a, b, c)

#define	YI_STRNCPY(a, b, c) strncpy(a, b, c)

#define	YI_STRRCHR(a, b) strrchr(a, b)

#define	YI_STRTOUL(a, b, c) strtoul(a, b, c)

#define	YI_VSNPRINTF(a, b, c, d) vsnprintf(a, b, c, d)

#define	YI_STRICMP(a, b) strcasecmp(a, b)

#define	YI_SPRINTF sprintf

#define	YI_SNPRINTF snprintf

#define	YI_ATOI(a) atoi(a)

#define	YI_ATOF(a) atof(a)

#define	YI_WCSCPY WCSCPY

#define	YI_WCSNCPY WCSNCPY

#define	YI_WCSLEN WCSLEN

#define	YI_WCSREV WCSREV

#define	YI_WCSCMP WCSCMP

#define	YI_WCSNCMP WCSNCMP

#define	YI_WCSICMP WCSICMP

#define	YI_WCSNICMP WCSNICMP

#define	YI_WCSCAT WCSCAT

#define	YI_WCSNCAT WCSNCAT

#define	YI_WCSSTR WCSSTR

#define	YI_WCSCHR WCSCHR

#define	YI_SWPRINTF swprintf

#define	YI_SLEEP(x) usleep((x)*1000)

#define	YI_USLEEP(x) usleep(x)

#define	YI_FILE FILE

#define	YI_FREAD (int32_t) fread

#define	YI_FWRITE fwrite

#define	YI_FGETC fgetc

#define	YI_FPUTC fputc

#define	_SIZE_T_DEFINED

#define	YI_SYSTEM_FREE(a) free(a)

#define	YI_SYSTEM_MALLOC(a) malloc(a)

#define	YI_SYSTEM_REALLOC(a, b) realloc(a, b)

#define	YI_MEMCMP(a, b, c) memcmp(a, b, c)

#define	YI_MEMMOVE(a, b, c) memmove(a, b, c)

#define	YI_MEMCOPY(a, b, c) memcpy(a, b, c)

#define	YI_MEMSET(a, b, c) memset(a, b, c)

#define	YI_STRCAT(a, b) strcat(a, b)

#define	YI_STRCHR(a, b) strchr(a, b)

#define	YI_STRCMP(a, b) strcmp(a, b)

#define	YI_STRCPY(a, b) strcpy(a, b)

#define	YI_STRLEN(a) strlen(a)

#define	YI_STRREV(a) STRREV(a)

#define	YI_STRNCMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNICMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNCAT(a, b, c) strncat(a, b, c)

#define	YI_STRNCPY(a, b, c) strncpy(a, b, c)

#define	YI_STRRCHR(a, b) strrchr(a, b)

#define	YI_STRTOUL(a, b, c) strtoul(a, b, c)

#define	YI_VSNPRINTF(a, b, c, d) vsnprintf(a, b, c, d)

#define	YI_STRICMP(a, b) strcasecmp(a, b)

#define	YI_SPRINTF sprintf

#define	YI_SNPRINTF snprintf

#define	YI_ATOI(a) atoi(a)

#define	YI_ATOF(a) atof(a)

#define	YI_WCSCPY WCSCPY

#define	YI_WCSNCPY WCSNCPY

#define	YI_WCSLEN WCSLEN

#define	YI_WCSREV WCSREV

#define	YI_WCSCMP WCSCMP

#define	YI_WCSNCMP WCSNCMP

#define	YI_WCSICMP WCSICMP

#define	YI_WCSNICMP WCSNICMP

#define	YI_WCSCAT WCSCAT

#define	YI_WCSNCAT WCSNCAT

#define	YI_WCSSTR WCSSTR

#define	YI_WCSCHR WCSCHR

#define	YI_SWPRINTF swprintf

#define	YI_SLEEP(x) usleep((x)*1000)

#define	YI_USLEEP(x) usleep(x)

#define	YI_FILE FILE

#define	YI_FREAD (int32_t) fread

#define	YI_FWRITE fwrite

#define	YI_FGETC fgetc

#define	YI_FPUTC fputc

#define	_SIZE_T

#define	_SIZE_T_DEFINED

#define	YI_SYSTEM_FREE(a) free(a)

#define	YI_SYSTEM_MALLOC(a) malloc(a)

#define	YI_SYSTEM_REALLOC(a, b) realloc(a, b)

#define	YI_MEMCMP(a, b, c) memcmp(a, b, c)

#define	YI_MEMMOVE(a, b, c) memmove(a, b, c)

#define	YI_MEMCOPY(a, b, c) memcpy(a, b, c)

#define	YI_MEMSET(a, b, c) memset(a, b, c)

#define	YI_STRCAT(a, b) strcat(a, b)

#define	YI_STRCHR(a, b) strchr(a, b)

#define	YI_STRCMP(a, b) strcmp(a, b)

#define	YI_STRCPY(a, b) strcpy(a, b)

#define	YI_STRLEN(a) strlen(a)

#define	YI_STRREV(a) STRREV(a)

#define	YI_STRNCMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNICMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNCAT(a, b, c) strncat(a, b, c)

#define	YI_STRNCPY(a, b, c) strncpy(a, b, c)

#define	YI_STRRCHR(a, b) strrchr(a, b)

#define	YI_STRTOUL(a, b, c) strtoul(a, b, c)

#define	YI_VSNPRINTF(a, b, c, d) vsnprintf(a, b, c, d)

#define	YI_STRICMP(a, b) strcasecmp(a, b)

#define	YI_SPRINTF sprintf

#define	YI_SNPRINTF snprintf

#define	YI_ATOI(a) atoi(a)

#define	YI_ATOF(a) atof(a)

#define	YI_WCSCPY WCSCPY

#define	YI_WCSNCPY WCSNCPY

#define	YI_WCSLEN WCSLEN

#define	YI_WCSREV WCSREV

#define	YI_WCSCMP WCSCMP

#define	YI_WCSNCMP WCSNCMP

#define	YI_WCSICMP WCSICMP

#define	YI_WCSNICMP WCSNICMP

#define	YI_WCSCAT WCSCAT

#define	YI_WCSNCAT WCSNCAT

#define	YI_WCSSTR WCSSTR

#define	YI_WCSCHR WCSCHR

#define	YI_SWPRINTF swprintf

#define	YI_SLEEP(x) sceKernelUsleep((x)*1000)

#define	YI_USLEEP(x) sceKernelUsleep(x)

#define	YI_FILE FILE

#define	YI_FREAD (int32_t) fread

#define	YI_FWRITE fwrite

#define	YI_FGETC fgetc

#define	YI_FPUTC fputc

#define	YI_HAS_VIRTUAL_KEYBOARD 1

#define	YI_HASINLINE

#define	YI_SYSTEM_FREE(a) free(a)

#define	YI_SYSTEM_MALLOC(a) malloc(a)

#define	YI_SYSTEM_REALLOC(a, b) realloc(a, b)

#define	YI_MEMCMP(dst, src, size) memcmp(dst, src, size)

#define	YI_MEMMOVE(dst, src, size) memmove(dst, src, size)

#define	YI_MEMCOPY(dst, src, size) memcpy(dst, src, size)

#define	YI_MEMSET(dst, src, size) memset(dst, src, size)

#define	YI_STRCAT(a, b) strcat(a, b)

#define	YI_STRCHR(a, b) strchr(a, b)

#define	YI_STRCMP(a, b) strcmp(a, b)

#define	YI_STRCPY(a, b) strcpy(a, b)

#define	YI_STRREV(a) _strrev(a)

#define	YI_STRLEN(a) (int32_t) strlen(a)

#define	YI_STRNCMP(a, b, c) strncmp(a, b, c)

#define	YI_STRNCPY(a, b, c) strncpy(a, b, c)

#define	YI_STRNCAT(a, b, c) strncat(a, b, c)

#define	YI_STRRCHR(a, b) strrchr(a, b)

#define	YI_STRTOUL(a, b, c) strtoul(a, b, c)

#define	YI_VSNPRINTF(s, c, f, a) _vsnprintf_s(s, c, _TRUNCATE, f, a)

#define	YI_STRICMP(a, b) _stricmp(a, b)

#define	YI_STRNICMP(a, b, c) _strnicmp(a, b, c)

#define	YI_SPRINTF sprintf

#define	YI_SNPRINTF(s, c, f, ...) _snprintf_s(s, c, _TRUNCATE, f, __VA_ARGS__)

#define	YI_ATOI(a) atoi(a)

#define	YI_ATOF(a) atof(a)

#define	YI_WCSCPY(a, b) wcscpy( a, b)

#define	YI_WCSNCPY(a, b, c) wcsncpy( a, b, (size_t)c)

#define	YI_WCSCAT(a, b) wcscat( a, b)

#define	YI_WCSLEN(a) (int32_t) wcslen(a)

#define	YI_WCSREV(a) _wcsrev( a)

#define	YI_WCSCMP(a, b) wcscmp( a, b)

#define	YI_WCSNCMP(a, b, c) wcsncmp( a, b, (size_t)c)

#define	YI_WCSICMP(a, b) _wcsicmp( a, b)

#define	YI_WCSNICMP(a, b, c) _wcsnicmp(a, b, (size_t)c)

#define	YI_WCSNCAT(a, b, c) wcsncat(a, b, (size_t)c)

#define	YI_WCSSTR WCSSTR

#define	YI_WCSCHR WCSCHR

#define	YI_SWPRINTF swprintf

#define	YI_SLEEP(x) ::Sleep(x)

#define	YI_USLEEP(x) ::Sleep((DWORD)(x) / 1000)

#define	YI_FILE FILE

#define	YI_FREAD (int32_t) fread

#define	YI_FWRITE fwrite

#define	YI_FGETC fgetc

#define	YI_FPUTC fputc

#define	YI_FERROR ferror

#define	YI_KEYCODE_BACK_BUTTON 0x00000008

#define	YI_ERROR_NONE 0

#define	YI_ERROR_NOTSUPPORT_BITDEPTH -10

#define	YI_ERROR_NOTSUPPORT_SCREENACCESS -20

#define	YI_ERROR_NOTSUPPORT_INPUTACCESS -30

#define	YI_ERROR_DISPLAY_BUFFER_CREATION -40

#define	YI_ASSERT(condition, tag, msg, ...) YI_REMOVE_CONSTANT_CONDITION(YI_UNUSED(sizeof(condition)); YI_UNUSED(tag);)
	Platform-independent assertion macro. More...

#define	YI_SIN (float)sin

#define	YI_COS (float)cos

#define	YI_FPOW(x, y) pow((float)x, (float)y)

#define	YI_SQRT(x) sqrt(x)

#define	YI_ITOFXW(x) ((x) << 16)

#define	YI_FXTOIW(x) ((x) >> 16)

#define	YI_DIVFXW(x, y) ((y << 16) / (x))

#define	YI_ITOFX(x) ((x) << 16)

#define	YI_FTOFX(x) (int32_t)((x)*65536)

#define	YI_DTOFX(x) (int32_t)((x)*65536)

#define	YI_FXTOI(x) ((x) >> 16)

#define	YI_FXTOF(x) ((float)(x) / 65536)

#define	YI_FXTOD(x) ((double)(x) / 65536)

#define	YI_MULFX(x, y) (((y) * (x)) >> 16)

#define	YI_MULFX2(x, y) ((((y)>> 16) * ((x)>> 16)))

#define	YI_DIVFX(x, y) (((x) << 16) / (y))

#define	YI_ABS(x) (((x) < 0) ? -(x) : (x))

#define	YI_FABS(x) (((x) < 0) ? -(x) : (x))

#define	YI_DABS(x) (((x) < 0) ? -(x) : (x))

#define	YI_SGN(x) (((x) > 0 ) ? 1 : ((x) < 0) ? -1 : 0)

#define	YI_FSGN(x) (((x) > 0 ) ? 1 : ((x) < 0) ? -1 : 0)

#define	YI_SGN2(x, y) (((x) > y ) ? 1 : ((x) < y) ? -1 : 0)

#define	YI_MAKE_VARIADIC_MACRO(fn, ...)

#define	YI_STRINGIFY(x)

#define	YI_CONCATENATE

#define	YI_STATIC_ASSERT(EXPRESSION, MSG)

#define	YI_WARNING(MSG)

#define	YI_ERROR(MSG)

#define	YI_ENSURE_STRING_LITERAL(x) "" x ""

#define	YI_TYPE_BASES(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_BASES_, ##__VA_ARGS__)

#define	YI_TYPE_DEF(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_, ##__VA_ARGS__)

#define	YI_TYPE_DEF_INST(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_INST_, ##__VA_ARGS__)

#define	YI_TYPE_DEF_WITH_NAME(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_WITH_NAME_, ##__VA_ARGS__)

#define	YI_TYPE_DEF_INST_WITH_NAME(...) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_INST_WITH_NAME_, ##__VA_ARGS__)

Typedefs
typedef uint8_t	yi::deprecated::YI_UINT8

typedef int8_t	yi::deprecated::YI_INT8

typedef uint16_t	yi::deprecated::YI_UINT16

typedef int16_t	yi::deprecated::YI_INT16

typedef uint32_t	yi::deprecated::YI_UINT32

typedef int32_t	yi::deprecated::YI_INT32

typedef uint64_t	yi::deprecated::YI_UINT64

typedef int64_t	yi::deprecated::YI_INT64

typedef float	yi::deprecated::YI_FLOAT

typedef double	yi::deprecated::YI_DOUBLE

typedef ssize_t	yi::deprecated::YI_UID

typedef wchar_t	yi::deprecated::YI_WCHAR

typedef char	yi::deprecated::YI_CHAR

typedef char16_t	yi::deprecated::YI_CHAR16

typedef char32_t	yi::deprecated::YI_CHAR32

typedef intptr_t	yi::deprecated::YI_INTPTR

typedef uintptr_t	yi::deprecated::YI_UINTPTR

typedef size_t	yi::deprecated::YI_SIZE

typedef ssize_t	yi::deprecated::YI_SSIZE

typedef void *	HANDLE

typedef unsigned long	size_t

typedef void *	HANDLE

typedef unsigned int	size_t

typedef void *	HANDLE

typedef int	ssize_t

typedef int32_t	YI_FILEWATCHID

typedef struct memsource_struct	YI_MEMSRC

typedef YiIntegralConstant< bool, true >	YiTrueType

typedef YiIntegralConstant< bool, false >	YiFalseType

Enumerations
enum	YI_BUFFER_REORENT { YI_BUFFER_REORIENT_0_DEGREES = 0, YI_BUFFER_REORIENT_90_DEGREES, YI_BUFFER_REORIENT_180_DEGREES, YI_BUFFER_REORIENT_270_DEGREES, YI_BUFFER_REORIENT_FLIPHORIZ, YI_BUFFER_REORIENT_FLIPVERT, YI_BUFFER_REORIENT_LIMIT }

enum	YI_PRIORITY_QUEUE_PRIORITY { YI_PRIORITY_QUEUE_HIGHEST = 2, YI_PRIORITY_QUEUE_HIGH = 1, YI_PRIORITY_QUEUE_NORMAL = 0, YI_PRIORITY_QUEUE_LOW = -1, YI_PRIORITY_QUEUE_LOWEST = -2, YI_PRIORITY_QUEUE_DEFAULT = YI_PRIORITY_QUEUE_NORMAL }

Functions
bool	operator== (const YI_RECT &rLHS, const YI_RECT &rRHS)

bool	operator!= (const YI_RECT &rLHS, const YI_RECT &rRHS)

bool	operator== (const YI_RECT_REL &rLHS, const YI_RECT_REL &rRHS)

bool	operator!= (const YI_RECT_REL &rLHS, const YI_RECT_REL &rRHS)

bool	operator< (const YI_FLOAT_RECT &lhs, const YI_FLOAT_RECT &rhs)

bool	operator> (const YI_FLOAT_RECT &lhs, const YI_FLOAT_RECT &rhs)

bool	operator<= (const YI_FLOAT_RECT &lhs, const YI_FLOAT_RECT &rhs)

bool	operator>= (const YI_FLOAT_RECT &lhs, const YI_FLOAT_RECT &rhs)

bool	operator== (const YI_FLOAT_RECT &rLHS, const YI_FLOAT_RECT &rRHS)

bool	operator!= (const YI_FLOAT_RECT &rLHS, const YI_FLOAT_RECT &rRHS)

bool	operator== (const YI_FLOAT_RECT_REL &rLHS, const YI_FLOAT_RECT_REL &rRHS)

bool	operator!= (const YI_FLOAT_RECT_REL &rLHS, const YI_FLOAT_RECT_REL &rRHS)

bool	operator== (const CYIColor &lhs, const CYIColor &rhs)

bool	operator!= (const CYIColor &lhs, const CYIColor &rhs)

bool	operator< (const CYIColor &lhs, const CYIColor &rhs)

std::ostream &	operator<< (std::ostream &rStream, const CYIDateTime &rVal)

YI_EXTERNINLINE int32_t	YI_FLOOR (float fVal)

YI_EXTERNINLINE int32_t	YI_FLOOR (double fVal)

YI_EXTERNINLINE int32_t	YI_CEIL (float fVal)

YI_EXTERNINLINE int32_t	YI_CEIL (double fVal)

YI_EXTERNINLINE int32_t	YI_ROUND (float fval)

YI_EXTERNINLINE int32_t	YI_ROUND (double fval)

YI_EXTERNINLINE int32_t	YI_DIFF (int32_t x, int32_t y)

int32_t	Log2 (int32_t a)

int32_t	Atan2i (int32_t y, int32_t x)

int32_t	AngleDiff (int32_t SrcAngle, int32_t TargetAngle)

int32_t	YI_INTSQRT (int32_t l2)

int32_t	YI_INTSQRT256 (int32_t l2)

int32_t	YI_POW (int32_t P, int32_t z)

YI_MEMSRC *	YI_MOPEN (const uint8_t *data, uint32_t size)

void	YI_MCLOSE (YI_MEMSRC *mp)

int32_t	YI_MTELL (YI_MEMSRC *mp)

void	YI_MSEEK (YI_MEMSRC *mp, int32_t pos, int32_t mode)

int32_t	YI_MREAD (void dest, int32_t size, int32_t count, YI_MEMSRC mp)

void *	YI_VOID_MOPEN (void data, char mode, uint32_t size)

void	YI_VOID_MCLOSE (void *mp)

int32_t	YI_VOID_MTELL (void *mp)

void	YI_VOID_MSEEK (void *mp, int32_t pos, int32_t mode)

int32_t	YI_VOID_MREAD (void dest, int32_t size, int32_t count, void mp)

void *	YI_VOID_FOPEN (void filepath, char mode, uint32_t size)

void	YI_VOID_FCLOSE (void *fp)

int32_t	YI_VOID_FTELL (void *fp)

void	YI_VOID_FSEEK (void *fp, int32_t pos, int32_t mode)

int32_t	YI_VOID_FREAD (void dest, int32_t size, int32_t count, void fp)

void *	YI_MALLOC (int32_t nSize)

void *	YI_CALLOC (int32_t nSize)

void *	YI_REALLOC (void *pOldBuf, int32_t nSize)

void	YI_FREE (void *pBuf)

std::ostream &	operator<< (std::ostream &stream, const CYIPreferences &val)

template<typename TARGET , typename SOURCE >
TARGET *	YiDynamicCast (SOURCE *pObject)
	Casts the pointer pObject to type T*. More...

template<typename TARGET , typename SOURCE >
std::shared_ptr< TARGET >	YiDynamicPointerCast (const std::shared_ptr< SOURCE > &pObject)
	Casts the shared pointer pObject to shared pointer type T*. More...

template<typename TARGET , typename SOURCE >
std::shared_ptr< TARGET >	YiDynamicCast (const std::shared_ptr< SOURCE > &pObject)
	Casts the shared pointer pObject to shared pointer type T*. More...

template<typename T >
std::unique_ptr< T >	YiRTTINew (const CYIString &name)
	Creates a new instance of the type identifed by name. More...

const CYIRuntimeTypeInfo *	YiGetTypeInfo (const char *pTypeName)

const CYIRuntimeTypeInfo *	YiGetTypeInfo (const CYIString &typeName)

template<typename T >
const CYIRuntimeTypeInfo *	YiGetTypeInfo (T *pObject)

std::ostream &	operator<< (std::ostream &stream, const CYIString &val)

std::istream &	operator>> (std::istream &stream, CYIString &val)

CYIString	operator+ (const CYIString &lhs, const CYIString &rhs)

wchar_t *	WStrDup (const wchar_t *pStr)

char *	YI_STRDUP (const char *pStr)

wchar_t *	WCSNCPY (wchar_t pDest, const wchar_t pSrc, int32_t nCount)

wchar_t *	WCSCPY (wchar_t pDest, const wchar_t pSrc)

int16_t	WCSNCMP (const wchar_t pDest, const wchar_t pSrc, int32_t nCount)

int16_t	WCSCMP (const wchar_t pStr1, const wchar_t pStr2)

int16_t	WCSNICMP (const wchar_t pDest, const wchar_t pSrc, int32_t nCount)

int16_t	WCSICMP (const wchar_t pStr1, const wchar_t pStr2)

int16_t	STRICMP (const char pStr1, const char pStr2)

int16_t	STRNICMP (const char pDest, const char pSrc, int32_t nCount)

wchar_t *	WCSCAT (wchar_t pDest, const wchar_t pSrc)

wchar_t *	WCSNCAT (wchar_t pDest, const wchar_t pSrc, int32_t nCount)

wchar_t *	WCSSTR (wchar_t pData, wchar_t pString)

wchar_t *	WCSCHR (wchar_t *pData, wchar_t iSymbol)

uint32_t	WCSLEN (const wchar_t *str)

wchar_t *	WCSREV (wchar_t *pSrc)

char *	STRREV (char *pSrc)

CYIString	YiTranslate (const CYIString &text)

CYIString	YiTranslateMarker (const CYIString &text)

bool	YiGetFileName (char &pFileName, char *pFilter)

CYIString	YiGetLocalDirectory ()

bool	YiMakeDirectory (const CYIString &sPath)

bool	YiDeleteFile (const char *pPath)

bool	YiCopyFile (const char pSourcePath, const char pDestinationPath)

bool	YiFilesAreIdentical (const char pReferencePath, const char pTestPath)

template<typename YI_SWAP_TYPE >
void	YI_SWAP (YI_SWAP_TYPE &a, YI_SWAP_TYPE &b)

YI_EXTERNINLINE uint16_t	RandomWORD (void)

YI_EXTERNINLINE int32_t	YI_MIN4 (int32_t a, int32_t b, int32_t c, int32_t d)

YI_EXTERNINLINE int32_t	YI_MAX4 (int32_t a, int32_t b, int32_t c, int32_t d)

bool	CompareNames (wchar_t Name, wchar_t Compare)

YI_FILE *	YI_FOPEN (const char pPath, const char pMode)

YI_FILE *	YI_WFOPEN (const wchar_t pPath, const wchar_t pMode)

void	YI_FCLOSE (YI_FILE *pFile)

void	YI_FSEEK (YI_FILE *pFile, int32_t nPos, int32_t nMode)

int32_t	YI_FTELL (YI_FILE *pFile)

int32_t	YI_TRUNCATE (YI_FILE *pFile, int32_t length)

uint64_t	YiGetTimeuS (void)

void	YILockFrameRate (int32_t nFPS)

uint8_t *	YiReadFile (YI_FILE pFile, uint32_t pBufferSize, uint32_t uAdditionalPadding)

std::vector< char >	YiBase64Encode (const char *pData, uint32_t unInputLength)

std::vector< char >	YiBase64Encode (const std::vector< char > &byteArray)

std::vector< char >	YiBase64Encode (const std::string &str)

std::vector< char >	YiBase64Encode (const CYIString &str)

std::vector< char >	YiBase64Decode (const char *pData, uint32_t unInputLength)

std::vector< char >	YiBase64Decode (const std::vector< char > &byteArray)

std::vector< char >	YiBase64Decode (const std::string &str)

std::vector< char >	YiBase64Decode (const CYIString &str)

bool	YiIsLittleEndian ()

bool	YiIsBigEndian ()

template<typename T , size_t N>
size_t	YI_SIZE_OF_ARRAY (const T(&a)[N])

static glm::vec3	CYIMatrixUtilities::TransformVector (const glm::mat4 &rMat4x4, const glm::vec3 &rV)

static glm::vec3	CYIMatrixUtilities::ProjectVector (const glm::vec3 &A, const glm::vec3 &normalizedB)

virtual int32_t	CYIParsingError::GetParsingErrorCode () const

virtual CYIString	CYIParsingError::GetParsingErrorMessage () const

virtual void	CYIParsingError::SetParsingErrorCode (int32_t eErrorCode)

virtual void	CYIParsingError::SetParsingErrorMessage (CYIString errorMessage)

virtual bool	CYIParsingError::HasError () const

virtual bool	CYIParsingError::IsRequiredField (const CYIString &rFieldName) const

Variables
const int32_t	YI_ANGLESHIFT

const int32_t	YI_ANGLE2PI

const int32_t	YI_ANGLEMASK

const float	YI_PI

const int32_t	YI_TRIG_SHIFT

const int32_t	YI_TRIG_MUL

const int32_t	YI_ATAN_SIZE

const int16_t	g_sYISine [YI_ANGLE2PI]

const int16_t	g_sYICosine [YI_ANGLE2PI]

const uint16_t	g_usYIArctan [YI_ATAN_SIZE+1]

const uint16_t	g_usYISqrt [256 *16]

const int32_t	YI_ANGLESHIFT = 11

const int32_t	YI_ANGLE2PI = 2048

const int32_t	YI_ANGLEPI = YI_ANGLE2PI / 2

const int32_t	YI_ANGLEMASK = YI_ANGLE2PI - 1

const float	YI_PI = 3.1415926535897932384626433832795f

const int32_t	YI_TRIG_SHIFT = 14

const int32_t	YI_TRIG_MUL = 16384

const int32_t	YI_ATAN_SIZE = (YI_ANGLE2PI / 4)

const int16_t	g_sYISine [YI_ANGLE2PI]

const int16_t	g_sYICosine [YI_ANGLE2PI]

const uint16_t	g_usYIArctan [YI_ATAN_SIZE+1]

const uint16_t	g_usYISqrt [4096]

Macro Definition Documentation

#define _SIZE_T

#define _SIZE_T_DEFINED

#define gets ( str ) YI_ERROR("gets: Does not check for buffer overflows (CWE-120, CWE-20). Use fgets() instead.")

#define sprintf	(	str,
		fmt,
		...
	)	YI_ERROR("sprintf: Does not check for buffer overflows (CWE-120). Use YI_SNPRINTF, YI_VSNPRINTF, or sprintf_s.")

#define strcat	(	dst,
		src
	)	YI_ERROR("strcat: Does not check for buffer overflows when concatenating to destination (CWE-120). Consider using YI_STRNCAT, strcat_s, or strlcat (warning, YI_STRNCAT is easily misused).")

#define strcpy	(	dst,
		src
	)	YI_ERROR("strcpy: Does not check for buffer overflows when copying to destination (CWE-120). Consider using YI_STRNCPY, strcpy_s, or strlcpy (warning, YI_STRNCAT is easily misused).")

#define swprintf	(	str,
		fmt,
		...
	)	YI_ERROR("swprintf: Does not check for buffer overflows (CWE-120). Use YI_SNPRINTF, YI_VSNPRINTF, or sprintf_s.")

#define wcscat	(	dst,
		src
	)	YI_ERROR("wcscat: Does not check for buffer overflows when concatenating to destination (CWE-120).")

#define wcscpy	(	dst,
		src
	)	YI_ERROR("wcscpy: Does not check for buffer overflows when copying to destination (CWE-120). Consider using a function version that stops copying at the end of the buffer.")

#define YI_ABS ( x ) (((x) < 0) ? -(x) : (x))

#define YI_ASSERT	(	condition,
		tag,
		msg,
		...
	)	YI_REMOVE_CONSTANT_CONDITION(YI_UNUSED(sizeof(condition)); YI_UNUSED(tag);)

Platform-independent assertion macro.

This macro gets turned into a no-op when you are building with debugging turned off. Be careful that the expression you pass to it does not perform actions that are vital for the correct behaviour of your program.

#define YI_ATOF ( a ) atof(a)

#define YI_ATOI ( a ) atoi(a)

#define YI_CONCATENATE

A macro used to concatenate two preprocessor tokens.

Example:

1 int YI_CONCATENATE(m_nUniqueMemberAtLine, __LINE__);

#define YI_COS (float)cos

#define YI_DABS ( x ) (((x) < 0) ? -(x) : (x))

#define YI_DEFAULT_COPY ( TypeName )

Value:

TypeName &operator=(const TypeName &) = default; \

TypeName(const TypeName &) = default;

Explicitly define the default copy constructor and assignment operator.

#define YI_DEFAULT_MOVE ( TypeName )

Value:

TypeName &operator=(TypeName &&) = default; \

TypeName(TypeName &&) = default;

Explicitly define the default move constructor and assignment operator.

#define YI_DEFAULT_MOVE_AND_COPY ( TypeName )

Value:

TypeName &operator=(const TypeName &) = default; \
    TypeName &operator=(TypeName &&) = default; \
    TypeName(const TypeName &) = default; \
    TypeName(TypeName &&) = default;

Explicitly define the copy constructor and move constructor, as well as assignment operators for each.

#define YI_DEFAULT_MOVE_NO_COPY ( TypeName )

Value:

TypeName &operator=(const TypeName &) = delete; \
    TypeName &operator=(TypeName &&) = default; \
    TypeName(const TypeName &) = delete; \
    TypeName(TypeName &&) = default;

Explicitly define the default move constructor and assignment operator, but disallow copying.

#define YI_DISABLE_URL_SECURITY

#define YI_DISALLOW_COPY_AND_ASSIGN ( TypeName )

Value:

TypeName(const TypeName &) = delete; \

TypeName &operator=(const TypeName &) = delete;

Delete the copy constructor and assignment operator (and consequently the move constructor as well)

#define YI_DIVFX	(	x,
		y
	)	(((x) << 16) / (y))

#define YI_DIVFXW	(	x,
		y
	)	((y << 16) / (x))

#define YI_DTOFX ( x ) (int32_t)((x)*65536)

#define YI_ENSURE_STRING_LITERAL ( x ) "" x ""

A macro used to ensure that an expression is a string literal

Example:

 YI_ENSURE_STRING_LITERAL("hello world."); // ok
 
 const char *msg = "hello world.";
 YI_ENSURE_STRING_LITERAL(msg); // compile error

#define YI_ENV_32 1

#define YI_ERROR ( MSG )

A macro that outputs the provided message as a compiler error. This is equivalent to #error, but can also be used within other macros.

Example:

1 #define A_REALLY_OLD_MACRO YI_ERROR("The macro A_REALLY_OLD_MACRO is no longer available. Please use A_NEWER_MACRO instead.")

#define YI_ERROR_DISPLAY_BUFFER_CREATION -40

#define YI_ERROR_NONE 0

#define YI_ERROR_NOTSUPPORT_BITDEPTH -10

#define YI_ERROR_NOTSUPPORT_INPUTACCESS -30

#define YI_ERROR_NOTSUPPORT_SCREENACCESS -20

#define YI_EXTERNINLINE

#define YI_FABS ( x ) (((x) < 0) ? -(x) : (x))

#define YI_FERROR ferror

#define YI_FGETC fgetc

#define YI_FILE FILE

#define YI_FLOAT_EQUAL	(	a,
		b
	)	((a) >= ((b) - FLT_EPSILON) && (a) <= ((b) + FLT_EPSILON))

#define YI_FORCE_INLINE inline

#define YI_FPOW	(	x,
		y
	)	pow((float)x, (float)y)

#define YI_FPUTC fputc

#define YI_FREAD (int32_t) fread

#define YI_FSGN ( x ) (((x) > 0 ) ? 1 : ((x) < 0) ? -1 : 0)

#define YI_FTOFX ( x ) (int32_t)((x)*65536)

#define YI_FUNCTION_SPECIALIZATION_FULLY_SUPPORTED

#define YI_FWRITE fwrite

#define YI_FXTOD ( x ) ((double)(x) / 65536)

#define YI_FXTOF ( x ) ((float)(x) / 65536)

#define YI_FXTOI ( x ) ((x) >> 16)

#define YI_FXTOIW ( x ) ((x) >> 16)

#define YI_HAS_VIRTUAL_KEYBOARD 1

#define YI_HAS_VIRTUAL_KEYBOARD

#define YI_HASINLINE

#define YI_INLINE

#define YI_ITOFX ( x ) ((x) << 16)

#define YI_ITOFXW ( x ) ((x) << 16)

#define YI_KEYCODE_BACK_BUTTON 0x00000004

#define YI_KEYCODE_BACK_BUTTON 0x00000008

#define YI_KEYCODE_HOME_BUTTON 0x00000003

#define YI_LITTLE_ENDIAN_16 ( a ) (a)

#define YI_LITTLE_ENDIAN_24 ( a ) (a)

#define YI_LITTLE_ENDIAN_32 ( a ) (a)

#define YI_LITTLE_ENDIAN_64 ( a ) (a)

#define YI_MAKE_VARIADIC_MACRO	(	fn,
		...
	)

A macro used to create a variadic macro. Calls to this macro are distributed to one or more other macros, depending on the number of parameters provided in the macro invocation. Up to 62 parameters are supported.

Example:

 #define MY_FUNCTION(...) YI_MAKE_VARIADIC_MACRO(MY_FUNCTION_, ##__VA_ARGS__)
 #define MY_FUNCTION_1(A) do_stuff(A);
 #define MY_FUNCTION_2(A, B) do_stuff((A), (B));

Warning: Avoid using the no-arguments version of variadic functions as it is not supported on platforms that use the Visual Studio compiler.

#define YI_MAX	(	a,
		b
	)	(((a) < (b)) ? (b) : (a))

#define YI_MAX_BUFFER 1024

#define YI_MAX_PATH 260

#define YI_MEMCMP	(	a,
		b,
		c
	)	memcmp(a, b, c)

#define YI_MEMCMP	(	a,
		b,
		c
	)	memcmp(a, b, c)

#define YI_MEMCMP	(	a,
		b,
		c
	)	memcmp(a, b, c)

#define YI_MEMCMP	(	a,
		b,
		c
	)	memcmp(a, b, c)

#define YI_MEMCMP	(	dst,
		src,
		size
	)	memcmp(dst, src, size)

#define YI_MEMCOPY	(	a,
		b,
		c
	)	memcpy(a, b, c)

#define YI_MEMCOPY	(	a,
		b,
		c
	)	memcpy(a, b, c)

#define YI_MEMCOPY	(	a,
		b,
		c
	)	memcpy(a, b, c)

#define YI_MEMCOPY	(	a,
		b,
		c
	)	memcpy(a, b, c)

#define YI_MEMCOPY	(	dst,
		src,
		size
	)	memcpy(dst, src, size)

#define YI_MEMMOVE	(	a,
		b,
		c
	)	memmove(a, b, c)

#define YI_MEMMOVE	(	a,
		b,
		c
	)	memmove(a, b, c)

#define YI_MEMMOVE	(	a,
		b,
		c
	)	memmove(a, b, c)

#define YI_MEMMOVE	(	a,
		b,
		c
	)	memmove(a, b, c)

#define YI_MEMMOVE	(	dst,
		src,
		size
	)	memmove(dst, src, size)

#define YI_MEMSET	(	a,
		b,
		c
	)	memset(a, b, c)

#define YI_MEMSET	(	a,
		b,
		c
	)	memset(a, b, c)

#define YI_MEMSET	(	a,
		b,
		c
	)	memset(a, b, c)

#define YI_MEMSET	(	a,
		b,
		c
	)	memset(a, b, c)

#define YI_MEMSET	(	dst,
		src,
		size
	)	memset(dst, src, size)

#define YI_MIN	(	a,
		b
	)	(((a) < (b)) ? (a) : (b))

#define YI_MULFX	(	x,
		y
	)	(((y) * (x)) >> 16)

#define YI_MULFX2	(	x,
		y
	)	((((y)>> 16) * ((x)>> 16)))

#define YI_NULL nullptr

Deprecated:: YI_NULL is deprecated and may be removed in future releases. Use nullptr instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

#define YI_REMOVE_CONSTANT_CONDITION ( x ) do { x } while ((void)0, 0)

This is a C++ trick for avoiding constant condition warnings, particularly in Microsoft compilers.

Note: Variadic arguments cannot be passed down into the condition body, as most compilers reset the VA_ARGS by the time it parses the code.

See also: https://msdn.microsoft.com/en-us/library/6t66728h.aspx

#define YI_SEEK_CUR 2

#define YI_SEEK_END 1

#define YI_SEEK_SET 0

#define YI_SGN ( x ) (((x) > 0 ) ? 1 : ((x) < 0) ? -1 : 0)

#define YI_SGN2	(	x,
		y
	)	(((x) > y ) ? 1 : ((x) < y) ? -1 : 0)

#define YI_SIN (float)sin

#define YI_SLEEP ( x ) sceKernelUsleep((x)*1000)

#define YI_SLEEP ( x ) usleep((x)*1000)

#define YI_SLEEP ( x ) ::Sleep(x)

#define YI_SNPRINTF snprintf

#define YI_SNPRINTF	(	s,
		c,
		f,
		...
	)	_snprintf_s(s, c, _TRUNCATE, f, __VA_ARGS__)

#define YI_SPRINTF sprintf

#define YI_SQRT ( x ) sqrt(x)

#define YI_STATIC_ASSERT	(	EXPRESSION,
		MSG
	)

Deprecated:: Please use static_assert instead.

A macro used to perform C++11-style static assertions. An identifier that can represent a C++ type must be used as message.

Example:

1 YI_STATIC_ASSERT(SOME_CONSTANT < 3, some_constant_must_be_smaller_than_3);

#define YI_STRCAT	(	a,
		b
	)	strcat(a, b)

#define YI_STRCAT	(	a,
		b
	)	strcat(a, b)

#define YI_STRCAT	(	a,
		b
	)	strcat(a, b)

#define YI_STRCAT	(	a,
		b
	)	strcat(a, b)

#define YI_STRCAT	(	a,
		b
	)	strcat(a, b)

#define YI_STRCHR	(	a,
		b
	)	strchr(a, b)

#define YI_STRCHR	(	a,
		b
	)	strchr(a, b)

#define YI_STRCHR	(	a,
		b
	)	strchr(a, b)

#define YI_STRCHR	(	a,
		b
	)	strchr(a, b)

#define YI_STRCHR	(	a,
		b
	)	strchr(a, b)

#define YI_STRCMP	(	a,
		b
	)	strcmp(a, b)

#define YI_STRCMP	(	a,
		b
	)	strcmp(a, b)

#define YI_STRCMP	(	a,
		b
	)	strcmp(a, b)

#define YI_STRCMP	(	a,
		b
	)	strcmp(a, b)

#define YI_STRCMP	(	a,
		b
	)	strcmp(a, b)

#define YI_STRCPY	(	a,
		b
	)	strcpy(a, b)

#define YI_STRCPY	(	a,
		b
	)	strcpy(a, b)

#define YI_STRCPY	(	a,
		b
	)	strcpy(a, b)

#define YI_STRCPY	(	a,
		b
	)	strcpy(a, b)

#define YI_STRCPY	(	a,
		b
	)	strcpy(a, b)

#define YI_STRICMP	(	a,
		b
	)	strcasecmp(a, b)

#define YI_STRICMP	(	a,
		b
	)	strcmp(a, b)

#define YI_STRICMP	(	a,
		b
	)	strcasecmp(a, b)

#define YI_STRICMP	(	a,
		b
	)	strcasecmp(a, b)

#define YI_STRICMP	(	a,
		b
	)	_stricmp(a, b)

#define YI_STRINGIFY ( x )

A macro used to convert a preprocessor token to a string.

Example:

1 std::cout << "Line number = " << YI_STRINGIFY(__LINE__) << std::endl;

Warning: This macro does not support being called with no arguments (e.g. YI_STRINGIFY() ).

#define YI_STRLEN ( a ) strlen(a)

#define YI_STRLEN ( a ) (int32_t) strlen(a)

#define YI_STRNCAT	(	a,
		b,
		c
	)	strncat(a, b, c)

#define YI_STRNCAT	(	a,
		b,
		c
	)	strncat(a, b, c)

#define YI_STRNCAT	(	a,
		b,
		c
	)	strncat(a, b, c)

#define YI_STRNCAT	(	a,
		b,
		c
	)	strncat(a, b, c)

#define YI_STRNCAT	(	a,
		b,
		c
	)	strncat(a, b, c)

#define YI_STRNCMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNCMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNCMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNCMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNCMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNCPY	(	a,
		b,
		c
	)	strncpy(a, b, c)

#define YI_STRNCPY	(	a,
		b,
		c
	)	strncpy(a, b, c)

#define YI_STRNCPY	(	a,
		b,
		c
	)	strncpy(a, b, c)

#define YI_STRNCPY	(	a,
		b,
		c
	)	strncpy(a, b, c)

#define YI_STRNCPY	(	a,
		b,
		c
	)	strncpy(a, b, c)

#define YI_STRNICMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNICMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNICMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNICMP	(	a,
		b,
		c
	)	strncmp(a, b, c)

#define YI_STRNICMP	(	a,
		b,
		c
	)	_strnicmp(a, b, c)

#define YI_STRRCHR	(	a,
		b
	)	strrchr(a, b)

#define YI_STRRCHR	(	a,
		b
	)	strrchr(a, b)

#define YI_STRRCHR	(	a,
		b
	)	strrchr(a, b)

#define YI_STRRCHR	(	a,
		b
	)	strrchr(a, b)

#define YI_STRRCHR	(	a,
		b
	)	strrchr(a, b)

#define YI_STRREV ( a ) STRREV(a)

#define YI_STRREV ( a ) _strrev(a)

#define YI_STRTOUL	(	a,
		b,
		c
	)	strtoul(a, b, c)

#define YI_STRTOUL	(	a,
		b,
		c
	)	strtoul(a, b, c)

#define YI_STRTOUL	(	a,
		b,
		c
	)	strtoul(a, b, c)

#define YI_STRTOUL	(	a,
		b,
		c
	)	strtoul(a, b, c)

#define YI_STRTOUL	(	a,
		b,
		c
	)	strtoul(a, b, c)

#define YI_STRUP ( a ) strdup(a)

#define YI_SWPRINTF swprintf

#define YI_SYSTEM_FREE ( a ) free(a)

#define YI_SYSTEM_MALLOC ( a ) malloc(a)

#define YI_SYSTEM_REALLOC	(	a,
		b
	)	realloc(a, b)

#define YI_SYSTEM_REALLOC	(	a,
		b
	)	realloc(a, b)

#define YI_SYSTEM_REALLOC	(	a,
		b
	)	realloc(a, b)

#define YI_SYSTEM_REALLOC	(	a,
		b
	)	realloc(a, b)

#define YI_SYSTEM_REALLOC	(	a,
		b
	)	realloc(a, b)

#define YI_TEXT ( quote ) (const char *)quote

#define YI_TEXT16 ( quote ) (const char16_t *)L##quote

#define YI_TEXT32 ( quote ) (const char32_t *)L##quote

#define YI_TYPE_BASES ( ... ) YI_MAKE_VARIADIC_MACRO(YI_TYPE_BASES_, ##__VA_ARGS__)

A macro used to declare a class as being an RTTI type.

To use, the macro should be inserted into the class declaration (typically in a header file). The the class name must be provided as the first argument to the macro. If the class has RTTI'ed bases, those bases should be listed, in order, after the class name. By convention, the call to YI_TYPE_BASES(...) is typically placed at the end of the class' declaration.

Example:

 class MyView : public CYISceneView
 {
     void Foo();
     YI_TYPE_BASES(MyView, CYISceneView)
 };

Note: The bases of the bases of the class should not be specified in the YI_TYPE_BASES(...) call. In the previous example, CYISceneNode is a base of CYISceneView, but is not listed in the YI_TYPE_BASES(...) call.

See also: YI_TYPE_DEF(...); YI_TYPE_DEF_INST(...)

#define YI_TYPE_DEF ( ... ) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_, ##__VA_ARGS__)

A macro used to define a class as being a non-instantiable RTTI type.

To use, the macro should be inserted in a compilation unit (typically the class's cpp file). The same arguments should be provided to this macro as to YI_TYPE_BASES(...). By convention, the call to YI_TYPE_DEF(...) is typically placed near the top of the class' definition.

Example:

 YI_TYPE_DEF(MyView, CYISceneView)
 void MyView::Foo()
 {
    // foo function implementation
 }

Note: The bases of the bases of the class should not be specified in the YI_TYPE_BASES(...) call. In the previous example, CYISceneNode is a base of CYISceneView, but is not listed in the YI_TYPE_BASES(...) call.

See also: YI_TYPE_DEF_INST(...); YI_TYPE_BASES(...); YI_TYPE_DEF_WITH_NAME(...)

#define YI_TYPE_DEF_INST ( ... ) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_INST_, ##__VA_ARGS__)

A macro used to define a class as being an instantiable RTTI type.

To use, the macro should be inserted in a compilation unit (typically the class's cpp file). The same arguments should be provided to this macro as to YI_TYPE_BASES(...). By convention, the call to YI_TYPE_DEF_INST(...) is typically placed near the top of the class' definition.

Example:

 YI_TYPE_DEF_INST(MyView, CYISceneView)
 void MyView::Foo()
 {
 // foo function implementation
 }

Note: The bases of the bases of the class should not be specified in the YI_TYPE_BASES(...) call. In the previous example, CYISceneNode is a base of CYISceneView, but is not listed in the YI_TYPE_BASES(...) call.

See also: YI_TYPE_DEF(...); YI_TYPE_BASES(...); YI_TYPE_DEF_INST_WITH_NAME(...)

#define YI_TYPE_DEF_INST_WITH_NAME ( ... ) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_INST_WITH_NAME_, ##__VA_ARGS__)

A specialized version of YI_TYPE_DEF_INST(...) which allows for specifying the name used to identify the type in the CYIRTTIRegistry instance. This macro's typical use cases are for namespaced types and inner types.

Example:

 YI_TYPE_DEF_INST_WITH_NAME(MyView, "MyNamespace::MyView", CYISceneView)
 void MyView::Foo()
 {
 // foo function implementation
 }

See also: YI_TYPE_DEF_WITH_NAME(...); YI_TYPE_BASES(...); YI_TYPE_DEF_INST(...)

#define YI_TYPE_DEF_WITH_NAME ( ... ) YI_MAKE_VARIADIC_MACRO(YI_TYPE_DEF_WITH_NAME_, ##__VA_ARGS__)

A specialized version of YI_TYPE_DEF(...) which allows for specifying the name used to identify the type in the CYIRTTIRegistry instance. This macro's typical use cases are for namespaced types and inner types.

Example:

 YI_TYPE_DEF_WITH_NAME(MyView, "MyNamespace::MyView", CYISceneView)
 void MyView::Foo()
 {
 // foo function implementation
 }

See also: YI_TYPE_DEF_WITH_NAME_INST(...); YI_TYPE_BASES(...); YI_TYPE_DEF(...)

#define YI_UNUSED ( param ) (void)(param)

#define YI_UNUSED_ATTRIBUTE __attribute__((unused))

#define YI_USLEEP ( x ) sceKernelUsleep(x)

#define YI_USLEEP ( x ) usleep(x)

#define YI_USLEEP ( x ) ::Sleep((DWORD)(x) / 1000)

#define YI_VSNPRINTF	(	a,
		b,
		c,
		d
	)	vsnprintf(a, b, c, d)

#define YI_VSNPRINTF	(	a,
		b,
		c,
		d
	)	vsnprintf(a, b, c, d)

#define YI_VSNPRINTF	(	a,
		b,
		c,
		d
	)	vsnprintf(a, b, c, d)

#define YI_VSNPRINTF	(	a,
		b,
		c,
		d
	)	vsnprintf(a, b, c, d)

#define YI_VSNPRINTF	(	s,
		c,
		f,
		a
	)	_vsnprintf_s(s, c, _TRUNCATE, f, a)

#define YI_WARNING ( MSG )

A macro that outputs the provided message as a compiler warning. This is equivalent to #warning, but can also be used within other macros.

Example:

1 #define AN_OLD_MACRO YI_WARNING("The macro AN_OLD_MACRO has been deprecated. Please use A_NEWER_MACRO instead.")

#define YI_WCSCAT	(	a,
		b
	)	wcscat( a, b)

#define YI_WCSCAT WCSCAT

#define YI_WCSCAT	(	a,
		b
	)	wcscat( a, b)

#define YI_WCSCHR WCSCHR

#define YI_WCSCMP WCSCMP

#define YI_WCSCMP	(	a,
		b
	)	wcscmp( a, b)

#define YI_WCSCMP WCSCMP

#define YI_WCSCMP	(	a,
		b
	)	wcscmp( a, b)

#define YI_WCSCPY WCSCPY

#define YI_WCSCPY	(	a,
		b
	)	wcscpy( a, b)

#define YI_WCSCPY WCSCPY

#define YI_WCSCPY	(	a,
		b
	)	wcscpy( a, b)

#define YI_WCSICMP WCSICMP

#define YI_WCSICMP	(	a,
		b
	)	WCSICMP( a, b)

#define YI_WCSICMP	(	a,
		b
	)	_wcsicmp( a, b)

#define YI_WCSLEN WCSLEN

#define YI_WCSLEN ( a ) (int32_t) wcslen(a)

#define YI_WCSNCAT WCSNCAT

#define YI_WCSNCAT	(	a,
		b,
		c
	)	wcsncat(a, b, (size_t)c)

#define YI_WCSNCAT WCSNCAT

#define YI_WCSNCAT	(	a,
		b,
		c
	)	wcsncat(a, b, (size_t)c)

#define YI_WCSNCMP WCSNCMP

#define YI_WCSNCMP	(	a,
		b,
		c
	)	wcsncmp( a, b, (size_t)c)

#define YI_WCSNCMP WCSNCMP

#define YI_WCSNCMP	(	a,
		b,
		c
	)	wcsncmp( a, b, (size_t)c)

#define YI_WCSNCPY WCSNCPY

#define YI_WCSNCPY	(	a,
		b,
		c
	)	wcsncpy( a, b, (size_t)c)

#define YI_WCSNCPY WCSNCPY

#define YI_WCSNCPY	(	a,
		b,
		c
	)	wcsncpy( a, b, (size_t)c)

#define YI_WCSNICMP WCSNICMP

#define YI_WCSNICMP	(	a,
		b,
		c
	)	WCSNICMP(a, b, (size_t)c)

#define YI_WCSNICMP	(	a,
		b,
		c
	)	_wcsnicmp(a, b, (size_t)c)

#define YI_WCSREV WCSREV

#define YI_WCSREV ( a ) WCSREV( a)

#define YI_WCSREV ( a ) _wcsrev( a)

#define YI_WCSSTR WCSSTR

#define YI_WTEXT ( quote ) (const wchar_t *)L##quote

Typedef Documentation

typedef void* HANDLE

typedef unsigned int size_t

typedef unsigned long size_t

typedef int ssize_t

typedef char yi::deprecated::YI_CHAR

Deprecated:: YI_CHAR is deprecated and may be removed in future releases. Use char instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef char16_t yi::deprecated::YI_CHAR16

Deprecated:: YI_CHAR16 is deprecated and may be removed in future releases. Use char16_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef char32_t yi::deprecated::YI_CHAR32

Deprecated:: YI_CHAR32 is deprecated and may be removed in future releases. Use char32_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef double yi::deprecated::YI_DOUBLE

Deprecated:: YI_DOUBLE is deprecated and may be removed in future releases. Use double instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef int32_t YI_FILEWATCHID

The file watch ID type used for managing files watches.

typedef float yi::deprecated::YI_FLOAT

Deprecated:: YI_FLOAT is deprecated and may be removed in future releases. Use float instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef int16_t yi::deprecated::YI_INT16

Deprecated:: YI_UINT16 is deprecated and may be removed in future releases. Use int16_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef int32_t yi::deprecated::YI_INT32

Deprecated:: YI_UINT32 is deprecated and may be removed in future releases. Use int32_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef int64_t yi::deprecated::YI_INT64

Deprecated:: YI_UINT64 is deprecated and may be removed in future releases. Use int64_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef int8_t yi::deprecated::YI_INT8

Deprecated:: YI_UINT8 is deprecated and may be removed in future releases. Use int8_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef intptr_t yi::deprecated::YI_INTPTR

Deprecated:: YI_INTPTR is deprecated and may be removed in future releases. Use intptr_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef struct memsource_struct YI_MEMSRC

typedef size_t yi::deprecated::YI_SIZE

Deprecated:: YI_SIZE is deprecated and may be removed in future releases. Use size_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef ssize_t yi::deprecated::YI_SSIZE

Deprecated:: YI_SSIZE is deprecated and may be removed in future releases. Use ssize_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef ssize_t yi::deprecated::YI_UID

Deprecated:: YI_UID is deprecated and may be removed in future releases. Use ssize_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef uint16_t yi::deprecated::YI_UINT16

Deprecated:: YI_UINT16 is deprecated and may be removed in future releases. Use uint16_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef uint32_t yi::deprecated::YI_UINT32

Deprecated:: YI_UINT32 is deprecated and may be removed in future releases. Use uint32_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef uint64_t yi::deprecated::YI_UINT64

Deprecated:: YI_UINT64 is deprecated and may be removed in future releases. Use uint64_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef uint8_t yi::deprecated::YI_UINT8

Deprecated:: YI_UINT8 is deprecated and may be removed in future releases. Use uint8_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef uintptr_t yi::deprecated::YI_UINTPTR

Deprecated:: YI_UINTPTR is deprecated and may be removed in future releases. Use uintptr_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef wchar_t yi::deprecated::YI_WCHAR

Deprecated:: YI_WCHAR is deprecated and may be removed in future releases. Use wchar_t instead, or define YI_DEPRECATED_TYPES in your project to enable the use of deprecated types.

typedef YiIntegralConstant<bool, false> YiFalseType

A backported equivalent of std::false_type, making the feature available on platforms that don't implement it.

See http://en.cppreference.com/w/cpp/types/integral_constant for more details.

typedef YiIntegralConstant<bool, true> YiTrueType

A backported equivalent of std::true_type, making the feature available on platforms that don't implement it.

See http://en.cppreference.com/w/cpp/types/integral_constant for more details.

Enumeration Type Documentation

enum YI_BUFFER_REORENT

Enumerator
YI_BUFFER_REORIENT_0_DEGREES
YI_BUFFER_REORIENT_90_DEGREES
YI_BUFFER_REORIENT_180_DEGREES
YI_BUFFER_REORIENT_270_DEGREES
YI_BUFFER_REORIENT_FLIPHORIZ
YI_BUFFER_REORIENT_FLIPVERT
YI_BUFFER_REORIENT_LIMIT

enum YI_PRIORITY_QUEUE_PRIORITY

Defines the priority of items in a CYIPriorityQueue.

Enumerator
YI_PRIORITY_QUEUE_HIGHEST	The highest priority. Items added to a CYIPriorityQueue with this priority will be placed before items with any other priority.
YI_PRIORITY_QUEUE_HIGH	Items added to a CYIPriorityQueue with this priority will be placed after items with priority YI_PRIORITY_QUEUE_HIGHEST and before items with any other priority.
YI_PRIORITY_QUEUE_NORMAL	Items added to a CYIPriorityQueue with this priority will be placed after items with priority YI_PRIORITY_QUEUE_HIGHEST or YI_PRIORITY_QUEUE_HIGH and before items with priority YI_PRIORITY_QUEUE_LOW or YI_PRIORITY_QUEUE_LOWEST.
YI_PRIORITY_QUEUE_LOW	Items added to a CYIPriorityQueue with this priority will be placed before items with priority YI_PRIORITY_QUEUE_LOWEST and after items with any other priority.
YI_PRIORITY_QUEUE_LOWEST	The lowest priotity. Items added to a CYIPriorityQueue with this priority will be placed after items with any other priority.
YI_PRIORITY_QUEUE_DEFAULT	The default priority when adding to a CYIPriorityQueue is YI_PRIORITY_QUEUE_NORMAL.

Function Documentation

int32_t AngleDiff	(	int32_t	SrcAngle,
		int32_t	TargetAngle
	)

int32_t Atan2i	(	int32_t	y,
		int32_t	x
	)

bool CompareNames	(	wchar_t *	Name,
		wchar_t *	Compare
	)

int32_t CYIParsingError::GetParsingErrorCode ( ) const

inlinevirtual

Returns the current parsing error status.

CYIString CYIParsingError::GetParsingErrorMessage ( ) const

inlinevirtual

Returns the current parsing error message, if an error has occurred.

bool CYIParsingError::HasError ( ) const

inlinevirtual

Returns true if a parsing error has occurred.

bool CYIParsingError::IsRequiredField ( const CYIString & rFieldName ) const

inlinevirtual

Returns true if the specified field is a required field.

int32_t Log2 ( int32_t a )

bool operator!=	(	const YI_RECT &	rLHS,
		const YI_RECT &	rRHS
	)

inline

bool operator!=	(	const YI_RECT_REL &	rLHS,
		const YI_RECT_REL &	rRHS
	)

inline

bool operator!=	(	const YI_FLOAT_RECT &	rLHS,
		const YI_FLOAT_RECT &	rRHS
	)

inline

bool operator!=	(	const YI_FLOAT_RECT_REL &	rLHS,
		const YI_FLOAT_RECT_REL &	rRHS
	)

inline

bool operator!=	(	const CYIColor &	lhs,
		const CYIColor &	rhs
	)

CYIString operator+	(	const CYIString &	lhs,
		const CYIString &	rhs
	)

bool operator<	(	const YI_FLOAT_RECT &	lhs,
		const YI_FLOAT_RECT &	rhs
	)

inline

bool operator<	(	const CYIColor &	lhs,
		const CYIColor &	rhs
	)

std::ostream& operator<<	(	std::ostream &	stream,
		const CYIPreferences &	val
	)

std::ostream& operator<<	(	std::ostream &	rStream,
		const CYIDateTime &	rVal
	)

std::ostream& operator<<	(	std::ostream &	stream,
		const CYIString &	val
	)

bool operator<=	(	const YI_FLOAT_RECT &	lhs,
		const YI_FLOAT_RECT &	rhs
	)

inline

bool operator==	(	const YI_RECT &	rLHS,
		const YI_RECT &	rRHS
	)

inline

bool operator==	(	const YI_RECT_REL &	rLHS,
		const YI_RECT_REL &	rRHS
	)

inline

bool operator==	(	const YI_FLOAT_RECT &	rLHS,
		const YI_FLOAT_RECT &	rRHS
	)

inline

bool operator==	(	const YI_FLOAT_RECT_REL &	rLHS,
		const YI_FLOAT_RECT_REL &	rRHS
	)

inline

bool operator==	(	const CYIColor &	lhs,
		const CYIColor &	rhs
	)

bool operator>	(	const YI_FLOAT_RECT &	lhs,
		const YI_FLOAT_RECT &	rhs
	)

inline

bool operator>=	(	const YI_FLOAT_RECT &	lhs,
		const YI_FLOAT_RECT &	rhs
	)

inline

std::istream& operator>>	(	std::istream &	stream,
		CYIString &	val
	)

Reads a single element from the stream stream and assigns it to the string val. By default, elements are delimited by whitespace characters, through this can be changed within the stream. The old value of val is discarded, even if an error occurred reading from the stream.

glm::vec3 CYIMatrixUtilities::ProjectVector	(	const glm::vec3 &	A,
		const glm::vec3 &	normalizedB
	)

inlinestatic

Projects the vector A onto the vector normalizedB.

Warning: The normalizedB vector must normalized.

YI_EXTERNINLINE uint16_t RandomWORD ( void )

void CYIParsingError::SetParsingErrorCode ( int32_t eErrorCode )

inlinevirtual

Sets the current parsing error status.

void CYIParsingError::SetParsingErrorMessage ( CYIString errorMessage )

inlinevirtual

Sets the current parsing error message.

int16_t STRICMP	(	const char *	pStr1,
		const char *	pStr2
	)

int16_t STRNICMP	(	const char *	pDest,
		const char *	pSrc,
		int32_t	nCount
	)

char* STRREV ( char * pSrc )

glm::vec3 CYIMatrixUtilities::TransformVector	(	const glm::mat4 &	rMat4x4,
		const glm::vec3 &	rV
	)

inlinestatic

Multiplies the matrix rMat4x4 by the vector rV. The value of rMat4x4[3][3] is expected to be 1.0f.

wchar_t* WCSCAT	(	wchar_t *	pDest,
		const wchar_t *	pSrc
	)

wchar_t* WCSCHR	(	wchar_t *	pData,
		wchar_t	iSymbol
	)

int16_t WCSCMP	(	const wchar_t *	pStr1,
		const wchar_t *	pStr2
	)

wchar_t* WCSCPY	(	wchar_t *	pDest,
		const wchar_t *	pSrc
	)

int16_t WCSICMP	(	const wchar_t *	pStr1,
		const wchar_t *	pStr2
	)

uint32_t WCSLEN ( const wchar_t * str )

wchar_t* WCSNCAT	(	wchar_t *	pDest,
		const wchar_t *	pSrc,
		int32_t	nCount
	)

int16_t WCSNCMP	(	const wchar_t *	pDest,
		const wchar_t *	pSrc,
		int32_t	nCount
	)

wchar_t* WCSNCPY	(	wchar_t *	pDest,
		const wchar_t *	pSrc,
		int32_t	nCount
	)

int16_t WCSNICMP	(	const wchar_t *	pDest,
		const wchar_t *	pSrc,
		int32_t	nCount
	)

wchar_t* WCSREV ( wchar_t * pSrc )

wchar_t* WCSSTR	(	wchar_t *	pData,
		wchar_t *	pString
	)

wchar_t* WStrDup ( const wchar_t * pStr )

void* YI_CALLOC ( int32_t nSize )

YI_EXTERNINLINE int32_t YI_CEIL ( float fVal )

YI_EXTERNINLINE int32_t YI_CEIL ( double fVal )

YI_EXTERNINLINE int32_t YI_DIFF	(	int32_t	x,
		int32_t	y
	)

void YI_FCLOSE ( YI_FILE * pFile )

YI_EXTERNINLINE int32_t YI_FLOOR ( float fVal )

YI_EXTERNINLINE int32_t YI_FLOOR ( double fVal )

YI_FILE* YI_FOPEN	(	const char *	pPath,
		const char *	pMode
	)

void YI_FREE ( void * pBuf )

void YI_FSEEK	(	YI_FILE *	pFile,
		int32_t	nPos,
		int32_t	nMode
	)

int32_t YI_FTELL ( YI_FILE * pFile )

int32_t YI_INTSQRT ( int32_t l2 )

int32_t YI_INTSQRT256 ( int32_t l2 )

void* YI_MALLOC ( int32_t nSize )

YI_EXTERNINLINE int32_t YI_MAX4	(	int32_t	a,
		int32_t	b,
		int32_t	c,
		int32_t	d
	)

void YI_MCLOSE ( YI_MEMSRC * mp )

YI_EXTERNINLINE int32_t YI_MIN4	(	int32_t	a,
		int32_t	b,
		int32_t	c,
		int32_t	d
	)

YI_MEMSRC* YI_MOPEN	(	const uint8_t *	data,
		uint32_t	size
	)

int32_t YI_MREAD	(	void *	dest,
		int32_t	size,
		int32_t	count,
		YI_MEMSRC *	mp
	)

void YI_MSEEK	(	YI_MEMSRC *	mp,
		int32_t	pos,
		int32_t	mode
	)

int32_t YI_MTELL ( YI_MEMSRC * mp )

int32_t YI_POW	(	int32_t	P,
		int32_t	z
	)

void* YI_REALLOC	(	void *	pOldBuf,
		int32_t	nSize
	)

YI_EXTERNINLINE int32_t YI_ROUND ( float fval )

YI_EXTERNINLINE int32_t YI_ROUND ( double fval )

template<typename T , size_t N>

size_t YI_SIZE_OF_ARRAY ( const T(&) a[N] )

inline

This templated function returns the number of elements from an array. The size of the array is determined at compile time.

Example:

 std::string strArray[] = {
     "Purple",
     "Monkey",
     "Dishwasher",
     "Tangerine"
 }
 
 size_t strCount = YI_SIZE_OF_ARRAY(strArray); // returns 4

It is equivalent to the following:

1 size_t strCount = sizeof(strArray) / sizeof(std::string);

1 size_t strCount = sizeof(strArray) / sizeof(*strArray);

1 size_t strCount = sizeof(strArray) / sizeof(strArray[0]);

char* YI_STRDUP ( const char * pStr )

template<typename YI_SWAP_TYPE >

void YI_SWAP	(	YI_SWAP_TYPE &	a,
		YI_SWAP_TYPE &	b
	)

inline

int32_t YI_TRUNCATE	(	YI_FILE *	pFile,
		int32_t	length
	)

void YI_VOID_FCLOSE ( void * fp )

void* YI_VOID_FOPEN	(	void *	filepath,
		char *	mode,
		uint32_t	size
	)

int32_t YI_VOID_FREAD	(	void *	dest,
		int32_t	size,
		int32_t	count,
		void *	fp
	)

void YI_VOID_FSEEK	(	void *	fp,
		int32_t	pos,
		int32_t	mode
	)

int32_t YI_VOID_FTELL ( void * fp )

void YI_VOID_MCLOSE ( void * mp )

void* YI_VOID_MOPEN	(	void *	data,
		char *	mode,
		uint32_t	size
	)

int32_t YI_VOID_MREAD	(	void *	dest,
		int32_t	size,
		int32_t	count,
		void *	mp
	)

void YI_VOID_MSEEK	(	void *	mp,
		int32_t	pos,
		int32_t	mode
	)

int32_t YI_VOID_MTELL ( void * mp )

YI_FILE* YI_WFOPEN	(	const wchar_t *	pPath,
		const wchar_t *	pMode
	)

std::vector<char> YiBase64Decode	(	const char *	pData,
		uint32_t	unInputLength
	)

This function will decode a given Base64 encoded byte array pointer with a given size into its original state.

std::vector<char> YiBase64Decode ( const std::vector< char > & byteArray )

inline

Helper wrapper function that decodes a given Base64 encoded byte array into its original state.

std::vector<char> YiBase64Decode ( const std::string & str )

inline

Helper wrapper function that decodes a given Base64 encoded standard string into its original state.

Warning: the null terminating character will be ignored

std::vector<char> YiBase64Decode ( const CYIString & str )

inline

Helper wrapper function that decodes a given Base64 encoded CYIString into its original state.

Warning: the null terminating character will be ignored

std::vector<char> YiBase64Encode	(	const char *	pData,
		uint32_t	unInputLength
	)

This function will encode a given byte array pointer with a given size into Base64.

std::vector<char> YiBase64Encode ( const std::vector< char > & byteArray )

inline

Helper wrapper function that will encode a given byte array into Base64.

std::vector<char> YiBase64Encode ( const std::string & str )

inline

Helper wrapper function that will encode a given standard string into Base64.

Warning: the null terminating character will be ignored

std::vector<char> YiBase64Encode ( const CYIString & str )

inline

Helper wrapper function that will encode a given CYIString into Base64.

Warning: the null terminating character will be ignored

bool YiCopyFile	(	const char *	pSourcePath,
		const char *	pDestinationPath
	)

bool YiDeleteFile ( const char * pPath )

template<typename TARGET , typename SOURCE >

TARGET* YiDynamicCast ( SOURCE * pObject )

inline

Casts the pointer pObject to type T*.

This function performs a dynamic cast on pointed-to object pObject, turning it into a pointer of type T*. If pObject cannot be cast to type T, nullptr is returned. If pObject is nullptr, nullptr is returned.

Example:

 CYISceneNode *pNode = pParent->GetChild(0);
 CYIPushButtonView *pButton = YiDynamicCast<CIYPushButtonView>(pNode);
 if (pButton)
 {
     // Perform actions on pButton
 }

Note: Both TARGET and SOURCE must be RTTI types. A compilation error will occur otherwise.; When called on a const pointer to SOURCE, this function returns a const pointer to TARGET.; If TARGET is a base of SOURCE (e.g. when performing an upcast), this function is equivalent to calling static_cast<TARGET*>(pObject).; When using non-virtual diamond inheritance and performing an upcast, it may be necessary to first perform a dynamic cast on one of the 'branches' of the diamond inheritance tree. Alternatively, use virtual inheritance instead of non-virtual inheritance.

Template Parameters

TARGET	The target type.
SOURCE	The source type.

template<typename TARGET , typename SOURCE >

std::shared_ptr<TARGET> YiDynamicCast ( const std::shared_ptr< SOURCE > & pObject )

inline

Casts the shared pointer pObject to shared pointer type T*.

This function performs a dynamic cast on pointed-to object pObject, turning it into a pointer of type T*. If pObject cannot be cast to type T, nullptr is returned. If pObject is nullptr, a null shared pointer is returned.

Note: This function is the YiRTTI equivalent of std::dynamic_pointer_cast.; Both TARGET and SOURCE must be RTTI types. A compilation error will occur otherwise.; When called on a const pointer to SOURCE, this function returns a const pointer to TARGET.; If TARGET is a base of SOURCE (e.g. when performing an upcast), this function is equivalent to calling std::static_pointer_cast<TARGET*>(pObject).; When using non-virtual diamond inheritance and performing an upcast, it may be necessary to first perform a dynamic cast on one of the 'branches' of the diamond inheritance tree. Alternatively, use virtual inheritance instead of non-virtual inheritance.

Template Parameters

TARGET	The target type.
SOURCE	The source type.

template<typename TARGET , typename SOURCE >

std::shared_ptr<TARGET> YiDynamicPointerCast ( const std::shared_ptr< SOURCE > & pObject )

inline

Casts the shared pointer pObject to shared pointer type T*.

This function performs a dynamic cast on pointed-to object pObject, turning it into a pointer of type T*. If pObject cannot be cast to type T, nullptr is returned. If pObject is nullptr, a null shared pointer is returned.

Note: This function is the YiRTTI equivalent of std::dynamic_pointer_cast.; Both TARGET and SOURCE must be RTTI types. A compilation error will occur otherwise.; When called on a const pointer to SOURCE, this function returns a const pointer to TARGET.; If TARGET is a base of SOURCE (e.g. when performing an upcast), this function is equivalent to calling std::static_pointer_cast<TARGET*>(pObject).; When using non-virtual diamond inheritance and performing an upcast, it may be necessary to first perform a dynamic cast on one of the 'branches' of the diamond inheritance tree. Alternatively, use virtual inheritance instead of non-virtual inheritance.

Template Parameters

TARGET	The target type.
SOURCE	The source type.

bool YiFilesAreIdentical	(	const char *	pReferencePath,
		const char *	pTestPath
	)

Compares the given files byte by byte and returns true if they are identical. Returns false early if the file sizes are different.

bool YiGetFileName	(	char &	pFileName,
		char *	pFilter
	)

CYIString YiGetLocalDirectory ( )

uint64_t YiGetTimeuS ( void )

const CYIRuntimeTypeInfo* YiGetTypeInfo ( const char * pTypeName )

Finds and returns the CYIRuntimeTypeInfo object identified by pTypeName. If no such type exists, nullptr is returned.

const CYIRuntimeTypeInfo* YiGetTypeInfo ( const CYIString & typeName )

Finds and returns the CYIRuntimeTypeInfo object identified by typeName. If no such type exists, nullptr is returned.

template<typename T >

const CYIRuntimeTypeInfo* YiGetTypeInfo ( T * pObject )

inline

Returns the runtime CYIRuntimeTypeInfo object associated with pObject. If pObject is nullptr, nullptr is returned.

bool YiIsBigEndian ( )

Returns true is the current system is big-endian, false otherwise.

bool YiIsLittleEndian ( )

Returns true is the current system is little-endian, false otherwise.

void YILockFrameRate ( int32_t nFPS )

bool YiMakeDirectory ( const CYIString & sPath )

uint8_t* YiReadFile	(	YI_FILE *	pFile,
		uint32_t *	pBufferSize,
		uint32_t	uAdditionalPadding
	)

template<typename T >

std::unique_ptr<T> YiRTTINew ( const CYIString & name )

Creates a new instance of the type identifed by name.

The resulting instance is cast to T* prior to being returned.

Note: If no RTTI type can be found with name name, a warning is logged and nullptr is returned.; If the specified RTTI type cannot be cast to T, a warning is logged and nullptr is returned.; If the specified RTTI type is not instantiable, a warning is logged and nullptr is returned.

Template Parameters

T	The target type.

CYIString YiTranslate ( const CYIString & text )

Translates the given text based on the current locale. If a string literal is passed, it will also mark that as being translateable.

CYIString YiTranslateMarker ( const CYIString & text )

Marks the given string literal as being translateable and returns text.

Variable Documentation

const int16_t g_sYICosine[YI_ANGLE2PI]

const int16_t g_sYISine[YI_ANGLE2PI]

const uint16_t g_usYIArctan[YI_ATAN_SIZE+1]

Initial value:

= { 0, 0, 1, 1, 2, 3, 3, 4, 5, 5, 6, 7, 7, 8, 8, 9, 10, 10, 11, 12, 12, 13,
                                                  13, 14, 15, 15, 16, 17, 17, 18, 19, 19, 20, 20, 21, 22, 22, 23, 24, 24, 25, 26, 26, 27,
                                                  27, 28, 29, 29, 30, 31, 31, 32, 32, 33, 34, 34, 35, 36, 36, 37, 38, 38, 39, 39, 40, 41,
                                                  41, 42, 43, 43, 44, 44, 45, 46, 46, 47, 48, 48, 49, 49, 50, 51, 51, 52, 53, 53, 54, 54,
                                                  55, 56, 56, 57, 57, 58, 59, 59, 60, 61, 61, 62, 62, 63, 64, 64, 65, 65, 66, 67, 67, 68,
                                                  68, 69, 70, 70, 71, 72, 72, 73, 73, 74, 75, 75, 76, 76, 77, 78, 78, 79, 79, 80, 81, 81,
                                                  82, 82, 83, 84, 84, 85, 85, 86, 87, 87, 88, 88, 89, 89, 90, 91, 91, 92, 92, 93, 94, 94,
                                                  95, 95, 96, 96, 97, 98, 98, 99, 99, 100, 101, 101, 102, 102, 103, 103, 104, 105, 105, 106, 106, 107,
                                                  107, 108, 109, 109, 110, 110, 111, 111, 112, 113, 113, 114, 114, 115, 115, 116, 116, 117, 118, 118, 119, 119,
                                                  120, 120, 121, 121, 122, 123, 123, 124, 124, 125, 125, 126, 126, 127, 127, 128, 129, 129, 130, 130, 131, 131,
                                                  132, 132, 133, 133, 134, 134, 135, 136, 136, 137, 137, 138, 138, 139, 139, 140, 140, 141, 141, 142, 142, 143,
                                                  143, 144, 144, 145, 145, 146, 147, 147, 148, 148, 149, 149, 150, 150, 151, 151, 152, 152, 153, 153, 154, 154,
                                                  155, 155, 156, 156, 157, 157, 158, 158, 159, 159, 160, 160, 161, 161, 162, 162, 163, 163, 164, 164, 165, 165,
                                                  166, 166, 167, 167, 167, 168, 168, 169, 169, 170, 170, 171, 171, 172, 172, 173, 173, 174, 174, 175, 175, 176,
                                                  176, 176, 177, 177, 178, 178, 179, 179, 180, 180, 181, 181, 182, 182, 182, 183, 183, 184, 184, 185, 185, 186,
                                                  186, 187, 187, 187, 188, 188, 189, 189, 190, 190, 191, 191, 191, 192, 192, 193, 193, 194, 194, 195, 195, 195,
                                                  196, 196, 197, 197, 198, 198, 198, 199, 199, 200, 200, 201, 201, 201, 202, 202, 203, 203, 203, 204, 204, 205,
                                                  205, 206, 206, 206, 207, 207, 208, 208, 208, 209, 209, 210, 210, 210, 211, 211, 212, 212, 212, 213, 213, 214,
                                                  214, 214, 215, 215, 216, 216, 216, 217, 217, 218, 218, 218, 219, 219, 220, 220, 220, 221, 221, 222, 222, 222,
                                                  223, 223, 223, 224, 224, 225, 225, 225, 226, 226, 226, 227, 227, 228, 228, 228, 229, 229, 229, 230, 230, 231,
                                                  231, 231, 232, 232, 232, 233, 233, 233, 234, 234, 235, 235, 235, 236, 236, 236, 237, 237, 237, 238, 238, 238,
                                                  239, 239, 239, 240, 240, 241, 241, 241, 242, 242, 242, 243, 243, 243, 244, 244, 244, 245, 245, 245, 246, 246,
                                                  246, 247, 247, 247, 248, 248, 248, 249, 249, 249, 250, 250, 250, 251, 251, 251, 252, 252, 252, 253, 253, 253,
                                                  254, 254, 254, 255, 255, 255, 255 }

const uint16_t g_usYISqrt[256 *16]

const uint16_t g_usYISqrt[4096]

const int32_t YI_ANGLE2PI = 2048

const int32_t YI_ANGLE2PI

const int32_t YI_ANGLEMASK = YI_ANGLE2PI - 1

const int32_t YI_ANGLEMASK

const int32_t YI_ANGLEPI = YI_ANGLE2PI / 2

const int32_t YI_ANGLESHIFT = 11

const int32_t YI_ANGLESHIFT

const int32_t YI_ATAN_SIZE = (YI_ANGLE2PI / 4)

const int32_t YI_ATAN_SIZE

const float YI_PI = 3.1415926535897932384626433832795f

const float YI_PI

const int32_t YI_TRIG_MUL = 16384

const int32_t YI_TRIG_MUL

const int32_t YI_TRIG_SHIFT = 14

const int32_t YI_TRIG_SHIFT

Detailed Description

Focus

Time

Localization

Strings

Run-Time Type Information (RTTI)

Files

Namespaces

Classes

Macros

Typedefs

Enumerations

Functions

Variables

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

Variable Documentation