xsi_miuserdata_defs.h

Go to the documentation of this file.

#ifndef XSI_MIUSERDATA_DEFS_H
#define XSI_MIUSERDATA_DEFS_H

#include <shader.h>

/* Transformation data ------------------------------------------*/

#define XSIMR_INSTANCETRANSFORMDATA_LABEL   0x00004210
#define XSIMR_INSTANCETRANSFORMDATA_VERSION 0x00000003

#define XSIMR_SHADOWINSTANCE_LABEL          0xf6a209ca      // From random.org

typedef enum
{
    E3DIF_Ignore        = 0,
    E3DIF_Back          = 1,
    E3DIF_Front         = 2,
    E3DIF_Both          = 3
} xsimrInstanceFaceFlags;

#define miDONTCARE          (miCBoolean)2

typedef struct
{
    miCBoolean              is_instance;

    miCBoolean              primary_visible;

    miCBoolean              transparent_receive;
    miCBoolean              transparent_cast;

    miCBoolean              reflection_receive;
    miCBoolean              reflection_cast;

    miCBoolean              refraction_receive;
    miCBoolean              refraction_cast;

    miCBoolean              fg_receive;
    miCBoolean              fg_cast;
    miCBoolean              fg_visible;

    miCBoolean              gi_receive;
    miCBoolean              gi_cast;
    miCBoolean              gi_visible;

    miCBoolean              caustic_receive;
    miCBoolean              caustic_cast;
    miCBoolean              caustic_visible;

    miCBoolean              shadow_receive;
    miCBoolean              shadow_cast;

    xsimrInstanceFaceFlags  face;
} xsimrInstanceFlags;

typedef struct
{
    miVector                scaling;
    miVector                translation;
    miQuaternion            rotation;
    miQuaternion            scale_orientation;
} xsimrInstanceTransform;

typedef struct
{
    miUint4                 version;            // Version + Byteswap indicator
    miCBoolean              si_scaling;         // Perform SI scaling (as opposed to classical)
    miCBoolean              motionblur;         // Do motion blur
    xsimrInstanceFlags      flags;              // Instance's visibility flags
    xsimrInstanceTransform  open_transform;     // Instance's transform on shutter open
    xsimrInstanceTransform  close_transform;    // Instance's transform on shutter close (or if no motion blur)
} xsimrInstanceTransformData;


/* -----------------------------------------------------------*/
#define XSIMR_LIGHTDATA_LABEL       2860411             
typedef enum
{
    XSIMR_LF_DIFFUSE            = 1 << 0,               
    XSIMR_LF_SPECULAR           = 1 << 1                
} xsimrLightFlags;
typedef struct
{
    xsimrLightFlags             flags;   
} xsimrLightData;

/* -----------------------------------------------------------*/
#define XSIMR_LIGHTILLUMDATA_KEY        "xsiLID"        
typedef struct
{
    miUint      struct_size;        
    miBoolean   set;                
    miScalar    diffuse;            
    miScalar    specular;           
    miColor     color;              
    miColor     shadow;             
} xsimrLightIllumData;

/* -----------------------------------------------------------*/
#define XSIMR_RENDERMAPDATA_LABEL       0x2C1ACA        
/* Profile Curves ---------------------------------------------*/
#define XSIMR_PROFILECURVEDATA_LABEL        0x9FDDD497; // random.org

typedef enum
{
    XSIMR_CE_CONSTANT           = 1,    
    XSIMR_CE_END_GRADIENT       = 2,    
    XSIMR_CE_CYCLE              = 3,    
    XSIMR_CE_CYCLE_RELATIVE     = 4     
} xsimrCurveExtrapolation;

typedef struct {
    xsimrCurveExtrapolation extrapolation_type;     
    miInteger               n_points;               
    miVector2d              points[ 1 ];            
} xsimrProfileCurveData;


/* Particle Shape -----------------------------------------------------------*/
#include <shader.h>
#include <geoshader.h>

#define XSIMR_POINTCLOUDDATA_LABEL          0x613EC66E      // random.org

#define XSIMR_POINTCLOUDDATA_VERSION        0x020000        // 2.0

typedef enum
{
    xsimrSHAPE_POINT,               
    xsimrSHAPE_SEGMENT,             
    xsimrSHAPE_DISC,                
    xsimrSHAPE_RECTANGLE,           
    xsimrSHAPE_SPHERE,              
    xsimrSHAPE_BOX,                 
    xsimrSHAPE_CYLINDER,            
    xsimrSHAPE_CAPSULE,             
    xsimrSHAPE_CONE,                
    xsimrSHAPE_BLOB,                
    xsimrNB_SIMPLE_SHAPES,          
    xsimrSHAPE_INSTANCE     = 128,  
} xsimrParticleShapeType;
typedef struct
{
    xsimrParticleShapeType      type;           
    miInteger                   instance_id;    
} xsimrParticleShape;


typedef struct
{
    miUint                      size;       
    miUint                      offset;     
} xsimrParticleBlob;

typedef enum
{
    xsimrATTRIBUTE_BOOLEAN,     
    xsimrATTRIBUTE_INTEGER,     
    xsimrATTRIBUTE_SCALAR,      
    xsimrATTRIBUTE_VECTOR2,     
    xsimrATTRIBUTE_VECTOR3,     
    xsimrATTRIBUTE_VECTOR4,     
    xsimrATTRIBUTE_QUATERNION,  
    xsimrATTRIBUTE_MATRIX33,    
    xsimrATTRIBUTE_MATRIX44,    
    xsimrATTRIBUTE_COLOR4,      
    xsimrATTRIBUTE_ROTATION,    
    xsimrATTRIBUTE_SHAPE,       
    xsimrATTRIBUTE_BLOB,        
} xsimrAttributeType;
typedef struct
{
    miTag           name;           // The attribute's name

    xsimrAttributeType  type;   // The attribute's data type

    miBoolean       constant;

    miUint          size;

    miTag           offsets;

    miTag           data;           // The userdata tag for the data blob.

    miTag           blob_type;
} xsimrAttributeData;


typedef struct
{
    miUint          version;            
    miUint          nb_particles;       
    miTag           positions;          
    int             i_data;             
    int             n_data;             
    xsimrAttributeData attributes[ 1 ]; 
} xsimrPointCloudData;


// Instance Marker

#define XSIMR_POINTCLOUD_INDEX_LABEL        0x613EC66F      
#define XSIMR_ATTRIBUTE_SHADER_KEY          "xsiATTR"       
typedef struct
{
    miUint          pc_index;   
    miUint          st_index;   
} xsimrPointCloudIndex;
// Time mapping data for attribute time-controlled images
typedef struct
{
    miScalar            range_min;      
    miScalar            range_max;      
    miInteger           index;          
} xsimrTimeMapValue;

typedef struct
{
    miInteger           n_time_map;         
    xsimrTimeMapValue   time_map[ 1 ];      
} xsimrAttributeImageTimeMap;

// Color Correction Look-up Table Definition

#define XSIMR_CCLUT_GAMMA_LABEL     0x0A63EC03  // random.org
#define XSIMR_CCLUT_1D_LABEL        0x0F2F2674  // random.org
#define XSIMR_CCLUT_3D_LABEL        0x088F67E5  // random.org

typedef struct
{
    miScalar        r, g, b;
} xsimrColor3;

typedef struct
{
    miScalar        red_gamma;
    miScalar        green_gamma;
    miScalar        blue_gamma;
} xsimrCCLUTGamma;

typedef struct
{
    miScalar        from;
    miScalar        to;
} xsimrCCLUTMapTuple;

typedef struct
{
    int             i_tuple;
    int             n_tuple;
    xsimrCCLUTMapTuple tuple[ 1 ];
} xsimrCCLUTRangeMap;

typedef struct 
{
    miTag           name;
    miTag           params;
} xsimrCCLUTPreTransform;

typedef struct
{
    xsimrCCLUTRangeMap  red_range;
    xsimrCCLUTRangeMap  green_range;
    xsimrCCLUTRangeMap  blue_range;

    int             i_lut;
    int             n_lut;
    xsimrColor3     lut[ 1 ];

    xsimrCCLUTPreTransform pretransform;
} xsimrCCLUT1D;

typedef struct
{
    xsimrCCLUTRangeMap  red_range;
    xsimrCCLUTRangeMap  green_range;
    xsimrCCLUTRangeMap  blue_range;

    // red_size * green_size * blue_size == n_lut
    int             red_size;
    int             green_size;
    int             blue_size;

    int             i_lut;
    int             n_lut;
    xsimrColor3     lut[ 1 ];

    xsimrCCLUTPreTransform pretransform;
} xsimrCCLUT3D;


#define XSIMR_MESHDATA_LABEL            0x112A61FF      // random.org
#define XSIMR_MESHDATA_VERSION          0x010000        // 1.0

typedef enum
{
    xsimrMESHATTRIBUTESTORAGE_CONSTANT, 
    xsimrMESHATTRIBUTESTORAGE_TSPACE,
} xsimrMeshAttributeStorage;

typedef struct
{
    char                        name[256];  // A string with the attribute name
    xsimrAttributeType          type;       // The attribute type. For constant storage, constant_data contains the per mesh value.
    xsimrMeshAttributeStorage   storage;    // The attribute storage. Attributes can be defined as tspace, per vertex userdata or constant.
    miInteger                   id;         // The index for tspace or vertex user data storage.

    // A union for the constant data.
    union 
    {
        miCBoolean      b;
        miInteger       i;
        miScalar        s;
        miVector2d      v2;
        miVector        v3;
        miQuaternion    v4;
        miVector        m33[3];
        miMatrix        m44;
        miColor         c;
    } constant_data;

} xsimrMeshAttribute;

typedef struct
{
    // An array of xsimrMeshAttribute that represents the pushed attributes
    int i_attributes;
    int n_attributes;
    xsimrMeshAttribute attributes[ 1 ];
} xsimrMesh;

#endif /* XSI_MIUSERDATA_DEFS_H */