maxtypes.h File Reference

#include "maxheap.h"
#include "WindowsDefines.h"
#include <Geom/maxcolors.h>
#include <cstdint>

Classes
class	Class_ID
class	Interface_ID

Macros
#define	TIME_TICKSPERSEC   4800
	Number of ticks in a second.
#define	TIME_PosInfinity   TimeValue(0x7fffffff)
	Returns a time value that represents positive infinity.
#define	TIME_NegInfinity   TimeValue(0x80000000)
	Returns a time value that represents negative infinity.

Typedefs
using	ulong = unsigned long
using	uchar = unsigned char
using	UBYTE = uchar
using	UWORD = unsigned short
using	MtlID = UWORD
using	TimeValue = int
using	SClass_ID = ulong

Enumerations
enum	IOResult : int { IO_OK = 0 , IO_END = 1 , IO_ERROR = 2 , IO_INTERRUPT = 3 }
enum	ChunkType { NEW_CHUNK = 0 , CONTAINER_CHUNK = 1 , DATA_CHUNK = 2 }
enum	FileIOType { IOTYPE_MAX = 0 , IOTYPE_MATLIB = 1 , IOTYPE_RENDER_PRESETS = 2 }

Functions
constexpr float	TicksToSec (TimeValue ticks)
	Converts from ticks to seconds.
constexpr TimeValue	SecToTicks (double secs)
	Converts from seconds to ticks.
constexpr TimeValue	TicksSecToTime (TimeValue ticks, double secs)
	Converts a number of seconds plus a number of ticks to a TimeValue.
constexpr void	TimeToTicksSec (TimeValue time, TimeValue &ticks, TimeValue &secs)
	Converts a TimeValue to a number of seconds plus a number of ticks.

Macro Definition Documentation

TIME_TICKSPERSEC

#define TIME_TICKSPERSEC   4800

Number of ticks in a second.

TIME_PosInfinity

#define TIME_PosInfinity   TimeValue(0x7fffffff)

Returns a time value that represents positive infinity.

TIME_NegInfinity

#define TIME_NegInfinity   TimeValue(0x80000000)

Returns a time value that represents negative infinity.

Typedef Documentation

ulong

using ulong = unsigned long

uchar

using uchar = unsigned char

UBYTE

using UBYTE = uchar

UWORD

using UWORD = unsigned short

MtlID

using MtlID = UWORD

TimeValue

using TimeValue = int

SClass_ID

using SClass_ID = ulong

Enumeration Type Documentation

ChunkType

enum ChunkType

Enumerator
NEW_CHUNK
CONTAINER_CHUNK
DATA_CHUNK

{
    NEW_CHUNK       = 0,
    CONTAINER_CHUNK = 1,
    DATA_CHUNK      = 2
};

FileIOType

enum FileIOType

Enumerator
IOTYPE_MAX	File IO concerns a scene file (.max, .viz).
IOTYPE_MATLIB	File IO concerns a material library file (.mat).
IOTYPE_RENDER_PRESETS	File IO concerns a render preset file (.rps).

{
    IOTYPE_MAX    = 0, 
    IOTYPE_MATLIB = 1, 
    IOTYPE_RENDER_PRESETS = 2
};

Function Documentation

TicksToSec()

float TicksToSec ( TimeValue ticks )

constexpr

Converts from ticks to seconds.

{ return ticks / static_cast<float>(TIME_TICKSPERSEC); }

SecToTicks()

TimeValue SecToTicks ( double secs )

constexpr

Converts from seconds to ticks.

{ 
    // Using static_cast will round down the result of the multiplication which is not always what we want
    // Since the function is constexpr, we can't use any math function such as std::round (not before C++23)
    // Trick used : 3.2 + 0.5 = 3.8 and static_cast<TimeValue>(3.8) = 3 or 3.7 + 0.5 = 4.2 and static_cast<TimeValue>(4.2) = 4.0
    double result = secs * TIME_TICKSPERSEC;
    result += 0.5;
    return static_cast<TimeValue>(result);
}

TicksSecToTime()

TimeValue TicksSecToTime ( TimeValue ticks, double secs )

constexpr

Converts a number of seconds plus a number of ticks to a TimeValue.

{ return ticks + SecToTicks(secs); }

TimeToTicksSec()

void TimeToTicksSec ( TimeValue time, TimeValue & ticks, TimeValue & secs )

constexpr

Converts a TimeValue to a number of seconds plus a number of ticks.

{
    ticks = time % TIME_TICKSPERSEC;
    secs = time / TIME_TICKSPERSEC;
}