VOP/VOP_Types.h

Go to the documentation of this file.

/*
 * PROPRIETARY INFORMATION.  This software is proprietary to
 * Side Effects Software Inc., and is not to be reproduced,
 * transmitted, or disclosed in any way without written permission.
 *
 * Produced by:
 *      Side Effects Software Inc
 *      477 Richmond Street West
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 *
 * NAME:        VOP_Language.h ( VOP Library, C++)
 *
 * COMMENTS:    This is an abstraction for different languages for VOPs.
 *              This class is basically a mapper from the parameters to types
 *              and other stuff.
 */

#ifndef __VOP_Types__
#define __VOP_Types__

#include "VOP_API.h"
#include <VEX/VEX_VexTypes.h>
#include <VEX/VEX_RslTypes.h>

template <typename T> class UT_RefArray;


typedef enum {
    // VEX types
    VOP_TYPE_UNDEF = VEX_TYPE_UNDEF,
    VOP_TYPE_VECTOR4 = VEX_TYPE_POINT,
    VOP_TYPE_VECTOR  = VEX_TYPE_VECTOR,
    VOP_TYPE_FLOAT   = VEX_TYPE_FLOAT,
    VOP_TYPE_INTEGER = VEX_TYPE_INTEGER,
    VOP_TYPE_STRING  = VEX_TYPE_STRING,
    VOP_TYPE_MATRIX3 = VEX_TYPE_MATRIX3,
    VOP_TYPE_MATRIX4 = VEX_TYPE_MATRIX4,
    VOP_TYPE_BSDF    = VEX_TYPE_BSDF,

    // RSL types
    VOP_TYPE_POINT,     // RSL point
    VOP_TYPE_NORMAL,    // RSL normal
    VOP_TYPE_COLOR,     // RSL color

    VOP_TYPE_ERROR,     // An error type (different than undefined type)

    // Shader types
    VOP_SHADER_START,           // Marker for start of shader types

    VOP_SURFACE_SHADER,
    VOP_SURFACE_SHADOW_SHADER,
    VOP_DISPLACEMENT_SHADER,
    VOP_GEOMETRY_SHADER,
    VOP_INTERIOR_SHADER,
    VOP_LIGHT_SHADER,
    VOP_LIGHT_SHADOW_SHADER,
    VOP_ATMOSPHERE_SHADER,
    VOP_LENS_SHADER,
    VOP_OUTPUT_SHADER,
    VOP_BACKGROUND_SHADER,
    VOP_PHOTON_SHADER,
    VOP_EMITTER_SHADER,
    VOP_PHOTONVOLUME_SHADER,
    VOP_ENVIRONMENT_SHADER,
    VOP_CONTOUR_SHADER,
    VOP_CONTOUR_STORE_SHADER,
    VOP_CONTOUR_CONTRAST_SHADER,
    VOP_TEXTURE_SHADER,
    VOP_IMAGE3D_SHADER,
    VOP_POP_SHADER, 
    VOP_SOP_SHADER, 
    VOP_CHOP_SHADER, 
    VOP_COP2_SHADER, 
    VOP_CVEX_SHADER,
    VOP_COSHADER_SHADER,
    VOP_PROPERTIES_SHADER,
    VOP_MUTABLE_SHADER,         // For switch & select which inherit input type
    VOP_MATERIAL_SHADER,        // Material: collection of shader vopnets
    VOP_VOP_MATERIAL_SHADER,    // Material: collecion of shaders in one vopnet

    VOP_SHADER_END,             // Marker for end of shader types

    VOP_MAX_TYPES,              // Sentinal, before the uniform types

    VOP_TYPE_UNIFORM_MODIFIER = 0x1000,
    VOP_TYPE_UFLOAT     = (VOP_TYPE_UNIFORM_MODIFIER | VOP_TYPE_FLOAT),
    VOP_TYPE_UVECTOR    = (VOP_TYPE_UNIFORM_MODIFIER | VOP_TYPE_VECTOR),
    VOP_TYPE_UPOINT     = (VOP_TYPE_UNIFORM_MODIFIER | VOP_TYPE_POINT),
    VOP_TYPE_UNORMAL    = (VOP_TYPE_UNIFORM_MODIFIER | VOP_TYPE_NORMAL),
    VOP_TYPE_UCOLOR     = (VOP_TYPE_UNIFORM_MODIFIER | VOP_TYPE_COLOR),
    VOP_TYPE_UMATRIX4   = (VOP_TYPE_UNIFORM_MODIFIER | VOP_TYPE_MATRIX4),
} VOP_Type;

#define VOP_BASE_TYPE(type)     ((VOP_Type)(type&(VOP_TYPE_UNIFORM_MODIFIER-1)))
#define VOP_GET_MODIFIER(type)  ((VOP_Type)(type&VOP_TYPE_UNIFORM_MODIFIER))
#define VOP_INVALID_TYPE(type)  ((type)==VOP_TYPE_UNDEF||(type)==VOP_TYPE_ERROR)
#define VOP_VALID_TYPE(type)    (!VOP_INVALID_TYPE(type))


/// Converts a VOP shader type to a corresponding VEX context type.
VOP_API VEX_ContextType     VOPconvertToVexContextType( VOP_Type shader_type );

/// Converts a VOP shader type to a corresponding RSL context type.
VOP_API RSL_ContextType     VOPconvertToRslContextType( VOP_Type shader_type );

/// Converts a VEX context type to a corresponding VOP shader type.
VOP_API VOP_Type            VOPconvertToShaderType( VEX_ContextType type ); 

/// Converts a RSL context type to a corresponding VOP shader type.
VOP_API VOP_Type            VOPconvertToShaderType( RSL_ContextType type);


/// A generic shader context type that can be interpreted as VEX_ContextType 
/// or RSL_ContextType
typedef int VOP_ContextType;
#define VOP_CONTEXT_TYPE_INVALID    0

/// A definition of the context type list.
typedef UT_RefArray<VOP_ContextType>    VOP_ContextTypeList;

/// Defines the known languages. Each of the languages has own set of context
/// types.
typedef enum {
    VOP_LANGUAGE_INVALID,
    VOP_LANGUAGE_VEX,
    VOP_LANGUAGE_RSL
} VOP_LanguageType;

/// Converts the 'shader_type' based on a language to a VEX or RSL 
/// context type encoded into the returned value of VOP_ContextType.
VOP_API VOP_ContextType     VOPconvertToContextType( VOP_Type shader_type,
                                                     VOP_LanguageType language);
/// Converts the context type to a 'shader type'.
VOP_API VOP_Type            VOPconvertToShaderType(  VOP_ContextType type,
                                                     VOP_LanguageType language);

/// Utility function to find out the context type based on the token
/// name and the language type.
VOP_API VOP_ContextType     VOPconvertToContextType( const char * context_name,
                                                     VOP_LanguageType language);


/// Utility function to turn VEX_ContextType into VOP_ContextType.
VOP_API VOP_ContextType     VOPconvertToContextType( VEX_ContextType type );

/// Utility function to turn RSL_ContextType into VOP_ContextType.
VOP_API VOP_ContextType     VOPconvertToContextType( RSL_ContextType type );

/// Utility function to turn VOP_ContextType into VEX_ContextType.
VOP_API VEX_ContextType     VOPconvertToVexContextType( VOP_ContextType type );

/// Utility function to turn VOP_ContextType into RSL_ContextType.
VOP_API RSL_ContextType     VOPconvertToRslContextType( VOP_ContextType type );

VOP_API bool    isValidPassThroughType (VOP_Type type);

#endif

---