RtTypes.h File Reference

Classes
struct	RtPoint
	3d point structure: More...
struct	RtPoint2f
	2D point structure: More...
struct	RtIntervalf
	Interval structure:. More...
struct	RtBoundingBox
	3D Bounding box structure: More...
struct	RtBoundingBox2D
	2D Bounding box structure: More...
struct	RtAxes3
	Axes structure:. More...
struct	RtUVcoord
	UV coordinates structure:. More...
struct	RtColor
	Color structure:. More...
struct	RtConDesc
	connector descriptor structure: More...
struct	RtQuat
	quaternion structure: More...
struct	RtObjFileHeaderInfo
	Object file header info:. More...
struct	RtLogEntry
	Log entry:. More...
struct	RtScriptErrorInfo
	Script error info:. More...
struct	RtDataStatus
	Data status:. More...
struct	RtMovement
	Movement structure:. More...
Typedefs
typedef char	RtChar
	RtChar.
typedef unsigned char	RtBYTE
	RtBYTE.
typedef GUID	CONID
	connector id:
typedef GUID	MSGID
	message id:
typedef GUID	RtStreamId
	mesh stream identification:
typedef RtQWORD	RtLocRntId
	local runtime Id:
typedef RtQWORD	RtPersistId
	persistant Id:
typedef RtDouble	RtMatrix [4][4]
	matrix 4x4:
typedef RtFloat	RtMatrix3f [3][3]
	float matrix 3x3:
typedef RtFloat	RtMatrixf [4][4]
	float matrix 4x4:
typedef RtUlong	RtActivityId
	activity runtime identification:
typedef RtUshort	RtObjFileVer
	object file version:
Enumerations
enum	RtConValidStatus
	connector validation status: More...
enum	RtConnectorEvent { CEVNT_ADDING = 0, CEVNT_ADDED = 1, CEVNT_REMOVING = 2, CEVNT_REMOVED = 3 }
	Connector registration events:. More...
enum	RtConnectionEvent { CNEVNT_CONNECTING = 0, CNEVNT_CONNECTED = 1, CNEVNT_DISCONNECTING = 2, CNEVNT_DISCONNECTED = 3 }
	connections registration events: More...
enum	RtTraversalType { DEPTH_FIRST = 0, BREATH_FIRST = 1 }
	traversal type for node iterator: More...
enum	RtSelMask { SEL_ADD = 0, SEL_REPLACE = 1 }
	selection mask: More...
enum	RtNumericDataEnum
	numerical data enumeration: More...
enum	RtMouseEventType { , MET_MOUSE_LEAVE }
	mouse event type: More...
enum	RtMouseKeyFlags { ,   MKF_CONTROL = MK_CONTROL, MKF_SHIFT = MK_SHIFT, MKF_LBUTTON = MK_LBUTTON, MKF_RBUTTON = MK_RBUTTON,   MKF_MBUTTON = MK_MBUTTON, MKF_WHEEL = 0x8000 }
enum	RtWindowType { ,   WND_CHILD_DOCKED, WND_FREE, WND_SHELF, WND_VIEWER,   WND_LIBRARY }
	window frame type: More...
enum	RtNotifyEvent {   NEVNT_SETVALUE = 1 , NEVNT_CONNECT = 4, NEVNT_DISCONNECTING = 8, NEVNT_ADDCONNECTOR = 16,   NEVNT_REMOVECONNECTOR = 32, NEVNT_RENAME = 64, NEVNT_CONDEPEND = 128 , NEVNT_CONCHANGED = 1024,   NEVNT_CUSTOM = 2048, NEVNT_OWNERIDCHANGED = 4096 }
enum	RtCachingMode { CACHEMODE_NEVER = 0, CACHEMODE_ALWAYS = 1, CACHEMODE_AUTO = 2 }
	Global caching mode:. More...
enum	RtControlFlow { CONTROL_FLOW_CLEAN = 0, CONTROL_FLOW_TAGGED = 1, CONTROL_FLOW_TERMINATED = 2, CONTROL_FLOW_ARCHIVED = 3 }
	Control flow tags:. More...
enum	RtActivityRunMode { ACTIVITY_RUN = 0, ACTIVITY_REINCARNATE = 1, ACTIVITY_REINCARNATE_AND_KEEP = 2 }
	Run Activity mode:. More...
enum	RtLogLevel { ,   LOGLEV_FATAL = 1, LOGLEV_ERROR = 2, LOGLEV_WARNING = 4, LOGLEV_INFO = 8,   LOGLEV_DEBUG = 16, LOGLEV_TRACE = 32, LOGLEV_ALL = LOGLEV_TRACE }
	Log levels:. More...

---

Detailed Description

---

Typedef Documentation

typedef char RtChar

RtChar.

typedef unsigned char RtBYTE

RtBYTE.

typedef GUID CONID

connector id:

typedef GUID MSGID

message id:

typedef GUID RtStreamId

mesh stream identification:

typedef RtQWORD RtLocRntId

local runtime Id:

typedef RtQWORD RtPersistId

persistant Id:

typedef RtDouble RtMatrix[4][4]

matrix 4x4:

typedef RtFloat RtMatrix3f[3][3]

float matrix 3x3:

typedef RtFloat RtMatrixf[4][4]

float matrix 4x4:

typedef RtUlong RtActivityId

activity runtime identification:

typedef RtUshort RtObjFileVer

object file version:

---

Enumeration Type Documentation

enum RtConValidStatus

connector validation status:

enum RtConnectorEvent

Connector registration events:.

Enumerator:

CEVNT_ADDING	connector is being added to a node:
CEVNT_ADDED	connector was added to a node:
CEVNT_REMOVING	connector is being removed from a node:
CEVNT_REMOVED	connector was removed from a node:

enum RtConnectionEvent

connections registration events:

Enumerator:

CNEVNT_CONNECTING	connection is being created:
CNEVNT_CONNECTED	connection was created:
CNEVNT_DISCONNECTING	connection is being destroyed:
CNEVNT_DISCONNECTED	connection is destroyed:

enum RtTraversalType

traversal type for node iterator:

Enumerator:

DEPTH_FIRST	depth first:
BREATH_FIRST	breath first (limitation : works only for first level of iteration):

enum RtSelMask

selection mask:

Enumerator:

SEL_ADD	adds to selection:
SEL_REPLACE	replaces selection:

enum RtNumericDataEnum

numerical data enumeration:

enum RtMouseEventType

mouse event type:

Enumerator:

MET_MOUSE_LEAVE

special sync event to synchronize tool mng event processing with command queue.

enum RtMouseKeyFlags

Enumerator:

MKF_CONTROL	the CTRL key is down. equals to MK_CONTROL:
MKF_SHIFT	the SHIFT key is down. equals to MK_SHIFT:
MKF_LBUTTON	the left mouse button is down. equals to MK_LBUTTON:
MKF_RBUTTON	the right mouse button is down. equals to MK_RBUTTON:
MKF_MBUTTON	the middle mouse button is down. equals to MK_MBUTTON
MKF_WHEEL	wheel is down (= active). This flag is set by tool manager. setting it in your code may cause undesired operations.

enum RtWindowType

window frame type:

Enumerator:

WND_CHILD_DOCKED	Common child window, with titlebar and border showed in client area of the main window.
WND_FREE	Common child window, without border showed in client area of the main window.
WND_SHELF	Window that is not restricted by client area of the main window (LE windows).
WND_VIEWER	Shelf Window (it is not restricted by client area of the main window too but requires special handling).
WND_LIBRARY	Viewer Window (it is not restricted by client area of the main window too but requires special handling).

enum RtNotifyEvent

Enumerator:

NEVNT_SETVALUE	basic event, sent after the new value is set. notification is propagdted to owners.
NEVNT_CONNECT	basic event, sent after the new connection is created. notification is propagated to owners from both ends ( source, destination).
NEVNT_DISCONNECTING	basic event, sent before the connection is destroyed. notification is propagated to owners from both ends ( source, destination).
NEVNT_ADDCONNECTOR	basic event, sent after the connector is added to node. notification is propagated to owners.
NEVNT_REMOVECONNECTOR	basic event, sent after the connector is removed from node. notification is propagated to owners.
NEVNT_RENAME	basic event, sent after the node is renamed. notification is propagated to owners.
NEVNT_CONDEPEND	basic event, sent after the connector dependences changed. notification is propagated to owners.
NEVNT_CONCHANGED	basic event, sent after the connector is renamed or flags changed. notification is propagated to owners.
NEVNT_CUSTOM	custom notify event. Implement IRsCustNodeSE interface to your node to be able receive the NEVNT_CUSTOM event.
NEVNT_OWNERIDCHANGED	owner changed (connected, disconnected, renamed) notification. nofification is send to the all affected nodes and their hooked objects, this notification is NOT propagated to the owner.

enum RtCachingMode

Global caching mode:.

Enumerator:

CACHEMODE_NEVER	never cache data in connectors:
CACHEMODE_ALWAYS	always cache data in connectors:
CACHEMODE_AUTO	automatic mode, trade-off between performance and memory requirements:

enum RtControlFlow

Control flow tags:.

Control flow tags are used to identify next transition path.

Enumerator:

CONTROL_FLOW_CLEAN	default state of control flow connector:
CONTROL_FLOW_TAGGED	tagged state identifies next transition path:
CONTROL_FLOW_TERMINATED	if occurred, it means current activity thread should be terminated:
CONTROL_FLOW_ARCHIVED	if occurred, it means current activity thread should be archived and reincarnated later with same ID (used e.g. in Pause Actv) so it can be stopped.

enum RtActivityRunMode

Run Activity mode:.

Enumerator:

ACTIVITY_RUN	default mode, run activity and assign new activityID for it:
ACTIVITY_REINCARNATE	try to reincarnate activity first (if has been archived previously), otherwise make normal run (special mode for Pause activity).
ACTIVITY_REINCARNATE_AND_KEEP	try to reincarnate activity first, otherwise make normal run and allow future reincarnations (used for activity events like Timer event).

enum RtLogLevel

Log levels:.

Enumerator:

LOGLEV_FATAL	no logging.
LOGLEV_ERROR	fatal error.
LOGLEV_WARNING	other (non-fatal) error.
LOGLEV_INFO	warning.
LOGLEV_DEBUG	info (executed command etc).
LOGLEV_TRACE	debug output.
LOGLEV_ALL	trace output (script trace etc).