VEX/VEX_VexTypes.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:        VEX_VexTypes.h ( VEX Library, C++)
 *
 * COMMENTS:    Data types for VEX variables
 */

#ifndef __VEX_VexTypes__
#define __VEX_VexTypes__

#include "VEX_API.h"

/// VEX variable types.
typedef enum {
    VEX_TYPE_UNDEF,             // Unknown type

    VEX_TYPE_POINT,             // Four scalars
    VEX_TYPE_VECTOR,            // Three scalars
    VEX_TYPE_FLOAT,             // A single scalar value
    VEX_TYPE_INTEGER,           // A single integer value
    VEX_TYPE_STRING,            // A character string
    VEX_TYPE_MATRIX3,           // A 3x3 (rotation) matrix
    VEX_TYPE_MATRIX4,           // A 4x4 (transform) matrix
    VEX_TYPE_BSDF,              // A BSDF

    VEX_MAX_TYPES               // Sentinel
} VEX_Type;


/// VEX is used in various contexts.  Each context has its own set of functions
/// and variables available.  The enum::VEX_ContextType can be used to limit
/// the VEX operator to a specific set of contexts.  Contexts can be or'ed
/// together.
typedef enum {
    /// Surface shading context
    VEX_SURFACE_CONTEXT         = 0x00000001,
    /// Displacement shading context
    VEX_DISPLACE_CONTEXT        = 0x00000002,
    /// Light shader context
    VEX_LIGHT_CONTEXT           = 0x00000004,
    /// Shadow/Occlusion shader context
    VEX_SHADOW_CONTEXT          = 0x00000008,
    /// Fog shader context
    VEX_FOG_CONTEXT             = 0x00000010,
    /// Photon shader context
    VEX_PHOTON_CONTEXT          = 0x00000020,
    /// CHOP (channel operator) context
    VEX_CHOP_CONTEXT            = 0x00000100,
    /// POP (particle operator) context
    VEX_POP_CONTEXT             = 0x00000400,
    /// SOP (surface operator) context
    VEX_SOP_CONTEXT             = 0x00000800,
    /// COP2 (composite operator) context
    VEX_COP2_CONTEXT            = 0x00001000,
    /// I3D (image3d) context
    VEX_I3D_CONTEXT             = 0x00010000,
    /// CVEX context
    /// @see @ref HDK_CVEX "Calling VEX from C++"
    VEX_CVEX_CONTEXT            = 0x00020000,
    VEX_INVALID_CONTEXT         = 0x00000000
} VEX_ContextType;

/// @def VEX_SHADING_CONTEXT Shading Contexts for mantra
#define VEX_SHADING_CONTEXT     (VEX_SURFACE_CONTEXT | \
                                 VEX_DISPLACE_CONTEXT | \
                                 VEX_LIGHT_CONTEXT | \
                                 VEX_SHADOW_CONTEXT | \
                                 VEX_FOG_CONTEXT | \
                                 VEX_PHOTON_CONTEXT)

/// @def VEX_OP_CONTEXT OP Contexts
#define VEX_OP_CONTEXT          (VEX_CHOP_CONTEXT | \
                                 VEX_POP_CONTEXT | \
                                 VEX_SOP_CONTEXT | \
                                 VEX_COP2_CONTEXT)

/// @def VEX_ALL_CONTEXT All contexts (shading, operator, i3d and CVEX)
#define VEX_ALL_CONTEXT         (VEX_SHADING_CONTEXT | \
                                 VEX_OP_CONTEXT | \
                                 VEX_I3D_CONTEXT | \
                                 VEX_CVEX_CONTEXT)



#endif

---