RmTypes.h

Go to the documentation of this file.

//=============================================================================
// filename: RmTypes.h                                                         
//                                                                             
//           ATI Research, Inc.                                                
//           3D Application Research Group                                     
//                                                                             
// Description: declaration file for RenderMonkey real-time Framework.         
//                                                                             
//=============================================================================
//   (C) 2004 ATI Research, Inc.  All rights reserved.                         
//=============================================================================

#ifndef _RM_CORE_TYPES_H_
#define _RM_CORE_TYPES_H_

//=============================================================================
//=============================================================================

//=============================================================================
// Include MFC Related    
//=============================================================================

#if _MSC_VER > 1000
#pragma once
#endif // _MSC_VER > 1000

#define VC_EXTRALEAN            // Exclude rarely-used stuff from Windows headers

#define OEMRESOURCE

#ifdef _UNICODE
   #ifndef UNICODE
      #define UNICODE
   #endif
#endif

//=============================================================================
// Windows                 
//=============================================================================
#include <windows.h>
#include <tchar.h>


//=============================================================================
// C Generic               
//=============================================================================
#include <assert.h>
#include <stdlib.h>
#include <stdio.h>
#include <memory.h>
#include <string.h>
#include <math.h>

//=============================================================================
// For GUID                     
//=============================================================================
#include <objbase.h>

//=============================================================================
// Definitions of RenderMonkey SDK library and plug-in DLLs export & import
//=============================================================================
#define RM_API_EXPORT __declspec(dllexport) 
#define RM_API_IMPORT __declspec(dllimport) 

//=============================================================================
// Used to specify whether methods are being exported from this library during its compilation and 
// linkage or being imported to be used in an another plug-in.     
//=============================================================================
#ifdef RMCORE_EXPORTS
   #define RM_API RM_API_EXPORT
#else
   #define RM_API RM_API_IMPORT
#endif

//=============================================================================
// Basic data types 
//=============================================================================
#define RM_CHAR   char       
#define RM_WCHAR  wchar_t    

#ifdef _UNICODE
   #define RM_TCHAR  RM_WCHAR     

   #ifndef UNICODE
      #define UNICODE
   #endif
#else
   #define RM_TCHAR  RM_CHAR      
#endif

#define RM_BYTE   unsigned char   
#define RM_WORD   unsigned short  
#define RM_DWORD  unsigned int    

#define RM_INT8   char            
#define RM_INT16  short           
#define RM_INT32  int             
#define RM_INT    int             

#define RM_LONG   long            
#define RM_ULONG  unsigned long   

#define RM_FLOAT  float           
#define RM_DOUBLE double          

#define RM_NODETYPE_COUNT 256     

typedef GUID RmPlugInID;          

//=============================================================================
//=============================================================================
class RM_API RmNodeID
{
public :

   //==========================================================================
   //==========================================================================
   RmNodeID() 
   {
      memset( &m_guid, 0, sizeof( GUID ) );

   }; // End of constructor

   //==========================================================================
   //==========================================================================
   RmNodeID( const GUID& guid ) 
   {
      memcpy( &m_guid, &guid, sizeof( GUID ) );

   }; // End of constructor

   //==========================================================================
   //==========================================================================
   RmNodeID( const RmNodeID& srcID ) 
   {
      memcpy( &m_guid, &srcID.GetGUID(), sizeof( GUID ) );

   }; // End of constructor

   //==========================================================================
   //==========================================================================
   virtual ~RmNodeID() {};

   //==========================================================================
   //==========================================================================
   bool operator == ( const RmNodeID& src )
   {
      if ( ::IsEqualGUID( m_guid, src.GetGUID() ) == TRUE )
      {
         return true;
      }

      return false;

   }; // End of operator ==

   //==========================================================================
   //==========================================================================
   void operator = ( const RmNodeID &src )
   {
      memcpy( &m_guid, &src.GetGUID(), sizeof( GUID ) );

   }; // End of operator =

   //==========================================================================
   //==========================================================================
   const GUID& GetGUID() const { return m_guid; };

private :
   GUID   m_guid; 

}; // End of RmNodeID

//=============================================================================
//=============================================================================
typedef enum 
{
   RM_PLUGINTYPE_GENERIC = 0,

   RM_PLUGINTYPE_EDITOR,

   RM_PLUGINTYPE_WORKSPACE_EDITOR,

   RM_PLUGINTYPE_IMPORTER,

   RM_PLUGINTYPE_EXPORTER,

   RM_PLUGINTYPE_EFFECTVIEWER,

   RM_PLUGINTYPE_GEOMETRY_LOADER,

   RM_PLUGINTYPE_TEXTURE_LOADER,

   RM_PLUGINTYPE_GENERATOR

} RmPlugInType; // End of RmPlugInType

//=============================================================================
//=============================================================================
typedef enum
{
   RM_EXPORT_DATA,    
   RM_SAVE_DATA       
}  RmExporterPlugInType;

//=============================================================================
//=============================================================================
typedef enum
{
   RM_WINDOWTYPE_ALL = 0,   
   RM_WINDOWTYPE_DLG,       
   RM_WINDOWTYPE_MDI,       
   RM_WINDOWTYPE_DOCKTOOL,  
   RM_WINDOWTYPE_NONE       
} RmWindowType; // End of RmWindowType

//=============================================================================
//=============================================================================
typedef enum
{
   RM_WINDOWDOCK_FLOAT = 0,      
   RM_WINDOWDOCK_LEFT,           
   RM_WINDOWDOCK_RIGHT,          
   RM_WINDOWDOCK_TOP,            
   RM_WINDOWDOCK_BOTTOM,         
   
} RmDockingPaneLayout; // End of RmDockingPaneLayout

//=============================================================================
//=============================================================================
typedef enum
{
   RS_ENUM = 0,            
   RS_BOOLEAN,             
   RS_MASK,                
   RS_INT,                 
   RS_FLOAT,               
   RS_COLOR,               
   RS_FLAG,                
   RS_ENUM_WITH_FLAG,      
   RS_TYPE_COUNT           

} RmStateType; // End of RmStateType 


//=============================================================================
//=============================================================================
typedef enum
{
   RM_ANGLE_DEGREE = 0,  
   RM_ANGLE_RADIAN       

} RmAngleType;

// Conversion methods between the two //
#define RM_RADIAN_TO_DEGREE   (360.0/6.2832) 
#define RM_DEGREE_TO_RADIAN   (6.2832/360.0) 

//=============================================================================
//=============================================================================
typedef enum
{
   RM_MATRIX_RAW = 0,     
   RM_MATRIX_ROTATE,      
   RM_MATRIX_TRANSLATE,   
   RM_MATRIX_SCALE,       
   RM_MATRIX_ORTHO,       
   RM_MATRIX_PERSPECTIVE  

} RmMatrixType; // End of RmMatrixType 

//=============================================================================
//=============================================================================
typedef enum
{
   RM_DX_LIGHT_POINT = 0,  
   RM_DX_LIGHT_SPOT,       
   RM_DX_LIGHT_DIRECTIONAL 

} RmLightType; // End of RmLightType

//=============================================================================
//=============================================================================
typedef enum
{
   RMVSDT_FLOAT1 = 0,    
   RMVSDT_FLOAT2,        
   RMVSDT_FLOAT3,        
   RMVSDT_FLOAT4,        
   RMVSDT_D3DCOLOR,      

   RMVSDT_UBYTE4,        
   RMVSDT_SHORT2,        
   RMVSDT_SHORT4         

} RmStreamChannelDataType; // End of RmStreamChannelDataType 

//=============================================================================
//=============================================================================
typedef enum
{
    RM_DECLUSAGE_POSITION = 0,  
    RM_DECLUSAGE_BLENDWEIGHT,   
    RM_DECLUSAGE_BLENDINDICES,  
    RM_DECLUSAGE_NORMAL,        
    RM_DECLUSAGE_PSIZE,         
    RM_DECLUSAGE_TEXCOORD,      
    RM_DECLUSAGE_TANGENT,       
    RM_DECLUSAGE_BINORMAL,      
    RM_DECLUSAGE_TESSFACTOR,    
    RM_DECLUSAGE_POSITIONT,     
    RM_DECLUSAGE_COLOR,         
    RM_DECLUSAGE_FOG,           
    RM_DECLUSAGE_DEPTH,         
    RM_DECLUSAGE_SAMPLE,        
    RM_DECLUSAGE_NUM            

} RmStreamChannelUsageType; // End of RmStreamChannelUsageType


//=============================================================================
//=============================================================================
typedef enum
{
   RM_PRIMITIVETYPE_POINT = 0,     
   RM_PRIMITIVETYPE_LINE,          
   RM_PRIMITIVETYPE_LINESTRIP,     
   RM_PRIMITIVETYPE_TRIANGLELIST,  
   RM_PRIMITIVETYPE_TRIANGLEFAN,   
   RM_PRIMITIVETYPE_TRIANGLESTRIP  

} RmPrimitiveType; // End of RmPrimitiveType


//=============================================================================
//=============================================================================
typedef enum 
{
   RM_SHADER_UNKNOWN = 0,   
   RM_SHADER_DX_VS_1_1,     
   RM_SHADER_DX_VS_2_0,     
   RM_SHADER_DX_VS_2_0_SW,  
   RM_SHADER_DX_VS_3_0,     
   RM_SHADER_DX_VS_3_0_SW,  
   RM_SHADER_DX_PS_1_1,     
   RM_SHADER_DX_PS_1_2,     
   RM_SHADER_DX_PS_1_3,     
   RM_SHADER_DX_PS_1_4,     
   RM_SHADER_DX_PS_2_0,     
   RM_SHADER_DX_PS_2_A,     
   RM_SHADER_DX_PS_2_B,     
   RM_SHADER_DX_PS_2_0_SW,  
   RM_SHADER_DX_PS_3_0,     
   RM_SHADER_DX_PS_3_0_SW   

} RmShaderVersion; // End of RmShaderVersion


//=============================================================================
//=============================================================================
typedef enum
{
   RM_PROJECTIONMODE_PERSPECTIVE = 0,  
   RM_PROJECTIONMODE_ORTHOGONAL        

} RmProjectionMode; // End of RmProjectionMode


//=============================================================================
//=============================================================================
typedef enum
{
   RM_COORDINATESYSTEM_LHS = 0,     
   RM_COORDINATESYSTEM_RHS,         

} RmCoordinateSystem; // End of RmCoordinateSystem

//=============================================================================
//=============================================================================
enum RmModelOrientation

{
   RM_ORIENTATION_LHS,  
   RM_ORIENTATION_RHS   

}; // End of RmModelOrientation enumeration

//=============================================================================
//=============================================================================
enum RmTextureOrigin

{
   RM_ORIGIN_TOP_LEFT,   
   RM_ORIGIN_BOTTOM_LEFT 

}; // End of RmTextureOrigin enumeration

//=============================================================================
//=============================================================================
struct RM_API RmGeneralPreferenceData
{
   RmGeneralPreferenceData() {};

   float fTimeCycle;

   BOOL  bTextureRefresh;
   float fTextureRefreshPeriod;

   BOOL  bModelRefresh;
   float fModelRefreshPeriod;

   RM_TCHAR  strDefaultTextureDirectory[ MAX_PATH ];

   RM_TCHAR  strDefaultModelDirectory[ MAX_PATH ];

   BOOL  bResetCameraOnEffectChange;   

   // Default orientation for newly created models
   RmModelOrientation modelOrientation;
   
   // Default origin for newly created textures
   RmTextureOrigin textureOrigin;

   // A flag to determine if the window settings (positions) are to be restored
   BOOL bRestoreDockingWindowSettings;

}; // End of RmGeneralPreferenceData


//=============================================================================
//=============================================================================
struct RM_API RmWindowPlacementData
{
   RmWindowPlacementData();

   RECT GetWindowRect() const;

   //--------------------------------------------------
   // Window placement data 
   //--------------------------------------------------
   int x;               
   int y;               
   int width;           
   int height;          

   // Location when minimized ( iconized )
   int minimizedX;      
   int minimizedY;      

   int showStatus;

   bool bVisible;

}; // End of RmWindowPlacementData

//=============================================================================
//=============================================================================
enum RmNodeUpdateType
{
   RM_NODE_GENERAL_UPDATE,          

   RM_NODE_NAME_CHANGED_UPDATE,   

   RM_NODE_VALUE_CHANGED_UPDATE,

   RM_NODE_ADDED_UPDATE,            

   RM_NODE_DELETED_UPDATE,          

}; // End of enum RmNodeUpdateType definition


//=============================================================================
//=============================================================================
enum RmTextureType
{
   RM_TEXTURE_2D = 0,    
   RM_TEXTURE_3D,        
   RM_TEXTURE_CUBEMAP,   
}; // End of enum RmTextureType definition


//=============================================================================
//=============================================================================
enum RmPixelFormatType
{  
   RM_PIXELFORMAT_UNKNOWN = 0,  
   RM_PIXELFORMAT_R8G8B8,       
   RM_PIXELFORMAT_A8R8G8B8,     
   RM_PIXELFORMAT_X8R8G8B8,     
   RM_PIXELFORMAT_R5G6B5,       
   RM_PIXELFORMAT_X1R5G5B5,     
   RM_PIXELFORMAT_A1R5G5B5,     
   RM_PIXELFORMAT_A4R4G4B4,     
   RM_PIXELFORMAT_R3G3B2,       
   RM_PIXELFORMAT_A8,           
   RM_PIXELFORMAT_A8R3G3B2,     
   RM_PIXELFORMAT_X4R4G4B4,     
   RM_PIXELFORMAT_A2B10G10R10,  
   RM_PIXELFORMAT_A8B8G8R8,     
   RM_PIXELFORMAT_X8B8G8R8,     
   RM_PIXELFORMAT_G16R16,       
   RM_PIXELFORMAT_A2R10G10B10,  
   RM_PIXELFORMAT_A16B16G16R16, 
   RM_PIXELFORMAT_A8P8,         
   RM_PIXELFORMAT_P8,           
   RM_PIXELFORMAT_L8,           
   RM_PIXELFORMAT_L16,          
   RM_PIXELFORMAT_A8L8,         
   RM_PIXELFORMAT_A4L4,         

   RM_PIXELFORMAT_V8U8,         
   RM_PIXELFORMAT_Q8W8V8U8,     
   RM_PIXELFORMAT_V16U16,       
   RM_PIXELFORMAT_Q16W16V16U16, 
   RM_PIXELFORMAT_CxV8U8,       

   RM_PIXELFORMAT_L6V5U5,       
   RM_PIXELFORMAT_X8L8V8U8,     
   RM_PIXELFORMAT_A2W10V10U10,  

   RM_PIXELFORMAT_MULTI2_ARGB8, 
   RM_PIXELFORMAT_G8R8_G8B8,    
   RM_PIXELFORMAT_R8G8_B8G8,    
   RM_PIXELFORMAT_DXT1,         
   RM_PIXELFORMAT_DXT2,         
   RM_PIXELFORMAT_DXT3,         
   RM_PIXELFORMAT_DXT4,         
   RM_PIXELFORMAT_DXT5,         
   RM_PIXELFORMAT_UYVY,         
   RM_PIXELFORMAT_YUY2,         

   RM_PIXELFORMAT_R16F,         
   RM_PIXELFORMAT_G16R16F,      
   RM_PIXELFORMAT_A16B16G16R16F,

   RM_PIXELFORMAT_R32F,         
   RM_PIXELFORMAT_G32R32F,      
   RM_PIXELFORMAT_A32B32G32R32F,

   RM_PIXELFORMAT_NUM_FORMATS   

}; // End of enum RmPixelFormatType definition


//=============================================================================
//=============================================================================
enum RmCubemapFaceType
{
   RM_CUBEMAP_FACE_X_POS = 0, 
   RM_CUBEMAP_FACE_X_NEG = 1, 
   RM_CUBEMAP_FACE_Y_POS = 2, 
   RM_CUBEMAP_FACE_Y_NEG = 3, 
   RM_CUBEMAP_FACE_Z_POS = 4, 
   RM_CUBEMAP_FACE_Z_NEG = 5  
}; // End of enum RmCubemapFaceType definition


//=============================================================================
// API identifier strings 
//=============================================================================
#define RM_DX_API        _T("D3D")          
#define RM_OPENGL_API    _T("OpenGL")       
#define RM_API_AGNOSTIC  _T("")             

//=============================================================================
// RenderMonkey node type string identifyiers. Use these for all type checks.
//=============================================================================
#define RM_NODE_TYPE                         _T("RmNode")
#define RM_EFFECT_WORKSPACE_TYPE             _T("RmEffectWorkspace")
#define RM_REGISTRY_BRANCH_TYPE              _T("RmRegistryBranch")
#define RM_EFFECT_GROUP_TYPE                 _T("RmEffectGroup")
#define RM_EFFECT_TYPE                       _T("RmEffect")
#define RM_OPENGL_EFFECT_TYPE                _T("RmOpenGLEffect")
#define RM_DIRECTX_EFFECT_TYPE               _T("RmDirectXEffect")
#define RM_VARIABLE_TYPE                     _T("RmVariable")
#define RM_DYNAMIC_VARIABLE_TYPE             _T("RmDynamicVariable" )
#define RM_COLOR_VARIABLE_TYPE               _T("RmColorVariable")
#define RM_VECTOR_VARIABLE_TYPE              _T("RmVectorVariable")
#define RM_FLOAT_VARIABLE_TYPE               _T("RmFloatVariable")
#define RM_FLOAT2_VARIABLE_TYPE              _T("RmFloat2Variable")
#define RM_FLOAT3_VARIABLE_TYPE              _T("RmFloat3Variable")
#define RM_MATRIX_VARIABLE_TYPE              _T("RmMatrixVariable")
#define RM_INTEGER_VARIABLE_TYPE             _T("RmIntegerVariable")
#define RM_BOOLEAN_VARIABLE_TYPE             _T("RmBooleanVariable")
#define RM_TEXTURE_VARIABLE_TYPE             _T("RmTextureVariable")
#define RM_2D_TEXTURE_VARIABLE_TYPE          _T("Rm2DTextureVariable")
#define RM_3D_TEXTURE_VARIABLE_TYPE          _T("Rm3DTextureVariable")  
#define RM_CUBEMAP_TEXTURE_VARIABLE_TYPE     _T("RmCubemapVariable")
#define RM_LIGHT_VARIABLE_TYPE               _T("RmLightVariable")
#define RM_MATERIAL_VARIABLE_TYPE            _T("RmMaterialVariable")
#define RM_PASS_TYPE                         _T("RmPass")
#define RM_OPENGL_PASS_TYPE                  _T("RmGLPass")
#define RM_MODEL_DATA_TYPE                   _T("RmModelData")
#define RM_MODEL_REFERENCE_TYPE              _T("RmModelReference")
#define RM_STREAM_MAP_TYPE                   _T("RmStreamMap")
#define RM_STREAM_MAP_REFERENCE_TYPE         _T("RmStreamMapReference")
#define RM_RENDERABLE_TEXTURE_TYPE           _T("RmRenderableTexture")
#define RM_RENDER_TARGET_TYPE                _T("RmRenderTarget")
#define RM_SHADER_TYPE                       _T("RmShader")
#define RM_HL_SHADER_TYPE                    _T("RmHLShader")
#define RM_GL_SHADER_TYPE                    _T("RmGLShader")
#define RM_HLSL_SHADER_TYPE                  _T("RmHLSLShader")
#define RM_RENDER_STATE_BLOCK_TYPE           _T("RmRenderStateBlock")
#define RM_STATE_TYPE                        _T("RmState")
#define RM_TEXTURE_OBJECT_TYPE               _T("RmTextureObject")
#define RM_TEXTURE_REFERENCE_TYPE            _T("RmTextureReference")
#define RM_LIGHT_OBJECT_TYPE                 _T("RmLightObject")
#define RM_LIGHT_REFERENCE_TYPE              _T("RmLightReference")
#define RM_MATERIAL_OBJECT_TYPE              _T("RmMaterialObject")
#define RM_MATERIAL_REFERENCE_TYPE           _T("RmMaterialReference")
#define RM_STREAM_TYPE                       _T("RmStream")
#define RM_STREAM_CHANNEL_TYPE               _T("RmStreamChannel")
#define RM_STRING_VARIABLE_TYPE              _T("RmStringVariable")
#define RM_SHADER_CONSTANT_TYPE              _T("RmShaderConstant")
#define RM_SAMPLER_TYPE                      _T("RmSampler")
#define RM_CAMERA_TYPE                       _T("RmCamera")
#define RM_CAMERA_REFERENCE_TYPE             _T("RmCameraReference")
#define RM_PLUGIN_DATA_TYPE                  _T("RmPlugInData")
#define RM_CLIPBOARD_NODE_TYPE               _T("RmClipboardNode")

//=============================================================================
//=============================================================================
typedef enum
{
   RM_ICON_SIZE_SMALL = 0, 
   RM_ICON_SIZE_LARGE,     
} RmIconSize;


//=============================================================================
// RenderMonkey Icon ID
//=============================================================================
typedef enum
{
   RM_RENDER_MONKEY_ICON_ID = 0,              
   RM_ATI_ICON_ID,              
   RM_WORKSPACE_ICON_ID,                            
   RM_REGISTRY_BRANCH_ICON_ID,                       
   RM_FOLDER_OPEN_ICON_ID,                              
   RM_EFFECT_ICON_ID,
   RM_OPENGL_ICON_ID,                                  
   RM_D3D_ICON_ID,                                    
   RM_VARIABLE_ICON_ID,
   RM_DYNAMIC_ICON_ID,                              
   RM_COLOR_ICON_ID,                         
   RM_VECTOR_1_ICON_ID,                              
   RM_VECTOR_2_ICON_ID,                              
   RM_VECTOR_3_ICON_ID,                              
   RM_VECTOR_4_ICON_ID,                              
   RM_MATRIX_2x2_ICON_ID,                            
   RM_MATRIX_3x3_ICON_ID,                            
   RM_MATRIX_4x4_ICON_ID,                            
   RM_INTEGER_ICON_ID,                              
   RM_TEXTURE_ICON_ID,                           
   RM_VOLUME_ICON_ID,                            
   RM_CUBEMAP_ICON_ID,                      
   RM_LIGHT_ICON_ID,                                  
   RM_MATERIAL_ICON_ID,                            
   RM_PASS_ICON_ID,                                             
   RM_PRINT_ICON_ID,                                             
   RM_MODEL_ICON_ID,                                      
   RM_MODEL_REFERENCE_ICON_ID,                       
   RM_STREAM_MAP_ICON_ID,                                 
   RM_STREAM_MAP_REFERENCE_ICON_ID,             
   RM_RENDERABLE_TEXTURE_ICON_ID,                 
   RM_RENDER_TARGET_ICON_ID,                           
   RM_RENDER_STATE_BLOCK_ICON_ID,                 
   RM_STATE_ICON_ID,                                           
   RM_VERTEX_TEXTURE_OBJECT_ICON_ID,                         
   RM_TEXTURE_OBJECT_ICON_ID,                         
   RM_TEXTURE_REFERENCE_ICON_ID,                   
   RM_LIGHT_OBJECT_ICON_ID,                             
   RM_LIGHT_REFERENCE_ICON_ID,                       
   RM_MATERIAL_OBJECT_ICON_ID,                       
   RM_MATERIAL_REFERENCE_ICON_ID,                 
   RM_STREAM_ICON_ID,                                         
   RM_STREAM_CHANNEL_ICON_ID,                         
   RM_STRING_ICON_ID,                       
   RM_SHADER_CONSTANT_ICON_ID,                       
   RM_SAMPLER_ICON_ID,                                       
   RM_SHADER_ICON_ID,
   RM_DISASSEMBLER_ICON_ID,
   RM_OUTPUT_ICON_ID,
   RM_CAMERA_ICON_ID,                                         
   RM_CAMERA_REFERENCE_ICON_ID,                     
   RM_VERTEX_SHADER_ICON_ID,
   RM_PIXEL_SHADER_ICON_ID,   
   RM_RENDER_TARGET_SCREEN_ICON_ID,
   RM_BOOLEAN_TRUE_ICON_ID,
   RM_BOOLEAN_FALSE_ICON_ID,              
   RM_CAMERA_ACTIVE_ICON_ID,
   RM_ART_ICON_ID,
   RM_ART_OVERLAY_ICON_ID,
   RM_DISABLED_OVERLAY_ICON_ID,
   RM_HLSL_OVERLAY_ICON_ID,
   RM_GLSL_OVERLAY_ICON_ID,
   RM_PREDEFINED_OVERLAY_ICON_ID,
   RM_PRELINKED_OVERLAY_ICON_ID,
   RM_CUT_ICON_ID,
   RM_COPY_ICON_ID,
   RM_PASTE_ICON_ID,
   RM_DELETE_ICON_ID,
   RM_ERROR_ICON_ID,
   RM_FOLDER_CLOSED_ICON_ID,
   RM_UNDO_ICON_ID,
   RM_REDO_ICON_ID,
   RM_INFO_ICON_ID,
   RM_WINDOW_CASCADE_ICON_ID,
   RM_WINDOW_TILE_HORIZONTAL_ICON_ID,
   RM_WINDOW_TILE_VERTICAL_ICON_ID,
   RM_PLUGIN_DATA_ICON_ID,

} RmIconID;

//=============================================================================
// SDK Version definitions 
//
// A plug-in must have current sdk version information in
// order for it to be loaded by RenderMonkey at startup
//=============================================================================
#define RENDERMONKEY_SDK_CURRENT_VERSION_MAJOR           1
#define RENDERMONKEY_SDK_CURRENT_VERSION_MINOR           6

//=============================================================================
// XML Version definitions 
//=============================================================================
#define RENDERMONKEY_XML_VERSION_1_0                     _T( "RenderMonkey 1.0" )
#define RENDERMONKEY_XML_VERSION_1_1                     _T( "RenderMonkey 1.1" )
#define RENDERMONKEY_XML_VERSION_1_5                     _T( "RenderMonkey 1.5" )
#define RENDERMONKEY_XML_VERSION_1_6                     _T( "RenderMonkey 1.6" )
#define RENDERMONKEY_XML_DEFAULT_VERSION                 RENDERMONKEY_XML_VERSION_1_0
#define RENDERMONKEY_XML_CURRENT_VERSION                 RENDERMONKEY_XML_VERSION_1_6

#define RENDERMONKEY_XML_CURRENT_DTD_VERSION             _T( "data\\RmDTDHeader.rfx" )

//=============================================================================
// Definitions of predefined variables update types. This signifies how the predefined variable 
// is updated by the preview window during each frame's rendering.           
//=============================================================================
#define RM_DEFINED_VARIABLE_UPDATE_PER_EFFECT   _T("Effect")     // The variable needs to be updated for each frame 
#define RM_DEFINED_VARIABLE_UPDATE_PER_PASS     _T("Pass")       // The variable needs to be updated each draw call

//=============================================================================
// Used for determination of state usages 
//=============================================================================
#define RM_RENDER_STATE_USAGE          _T("RENDER_STATE")
#define RM_TEXTURE_STAGE_STATE_USAGE   _T("TEXTURE_STATE")
#define RM_SAMPLER_STATE_USAGE         _T("SAMPLER_STATE")

//=============================================================================
// Used to find the named plugins
//=============================================================================
#define RM_TEXTURE_VIEWER_PLUGIN_ID       { 0xab857d87, 0xd308, 0x4293, { 0x82, 0x33, 0x5a, 0x2a, 0x51, 0x7a, 0xb9, 0x11 } }
#define RM_EXTERNAL_FILE_EDITOR_PLUGIN_ID { 0x47c91d6, 0x73f9, 0x4e64, { 0xae, 0x72, 0x20, 0x76, 0x7, 0xe5, 0x21, 0x23 } }
#define RM_WORKSPACE_EDITOR_PLUGIN_ID     { 0x6c3ed0be, 0xfc21, 0x47fb, { 0xb5, 0x4f, 0xac, 0xbc, 0xf, 0x17, 0xf7, 0xe2 } }
#define RM_DX9_VIEWER_PLUGIN_ID           { 0xd158f5f1, 0x9d5d, 0x4173, { 0x9f, 0xe3, 0x90, 0x65, 0x97, 0xdd, 0x96, 0x32 } }
#define RM_OPENGL_VIEWER_PLUGIN_ID        { 0x29aaa06f, 0xfae1, 0x4eb6, { 0x81, 0x7, 0x25, 0x6, 0x64, 0x64, 0x84, 0x4a } }
#define RM_TEXTURE_LOADER_PLUGIN_ID       { 0xf35b195d, 0xb325, 0x4365, { 0x9e, 0x21, 0x67, 0xc1, 0xd0, 0x8b, 0x4, 0x2 } }

//=============================================================================
//=============================================================================
class RmNode;
struct RmHighlightLine
{
   RmNode      *pNode;           
   RM_TCHAR    *szPassName;      
   int          nLineNumber;     
   RM_TCHAR    *szExtraString;   

};    // End of struct RmHighlightLine


//=============================================================================
// Generic Memory Allocation Function
//=============================================================================
RM_API RM_BYTE* RmAllocateBuffer( int sizeOfData );     
RM_API void     RmDeallocateBuffer( RM_BYTE* pBuffer ); 

//=============================================================================
//=============================================================================
enum RmViewerUpdateMode
{
   RM_UPDATE_FASTEST = 0, 
   RM_UPDATE_VSYNCH,      
   RM_UPDATE_REQUEST      

}; // End of RmViewerUpdateMode enumeration

//=============================================================================
//=============================================================================
enum RmViewerUIMode
{
   RM_UI_NONE = 0,  

   RM_UI_CAMERA_ROTATE,

   RM_UI_CAMERA_PAN,

   RM_UI_CAMERA_ZOOM,

   RM_UI_CAMERA_OVERLOAD,

   RM_UI_INPUT_MODE          

}; // End of RmViewerUIMode enumeration declaration

#endif // _RM_CORE_TYPES_H

---