HOM/HOM_EnumModules.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
 *      123 Front Street West, Suite 1401
 *      Toronto, Ontario
 *      Canada   M5J 2M2
 *      416-504-9876
 *
 * COMMENTS:
 *      This file contains classes that, when wrapped by swig, behave like
 *      submodules.  These submodules contain enumerated values.
 */

#ifndef __HOM_EnumModules_h__
#define __HOM_EnumModules_h__

#include "HOM_EnumValue.h"

#define HOM_ATTRIB_DATA_VALUES \
    Int, Float, String
HOM_DECLARE_ENUM_MODULE(attribData, 3, HOM_ATTRIB_DATA_VALUES)


#define HOM_ATTRIB_TYPE_VALUES \
    Point, Prim, Vertex, Global
HOM_DECLARE_ENUM_MODULE(attribType, 4, HOM_ATTRIB_TYPE_VALUES)


#define HOM_PRIM_TYPE_VALUES \
    Polygon, NURBSCurve, BezierCurve, Mesh, NURBSSurface, BezierSurface, \
    Circle, Sphere, Tube, Metaball, TriangleFan, TriangleStrip, \
    TriangleBezier, PastedSurface, Volume, ParticleSystem
HOM_DECLARE_ENUM_MODULE(primType, 16, HOM_PRIM_TYPE_VALUES)


#define HOM_PARM_DATA_VALUES \
    Int, Float, String, Ramp
HOM_DECLARE_ENUM_MODULE(parmData, 4, HOM_PARM_DATA_VALUES)


#define HOM_PARM_TYPE_CATEGORY_VALUES \
    Int, Float, String, Toggle, Menu, Button, FolderSet, Folder, Separator, \
    Label, Ramp
HOM_DECLARE_ENUM_MODULE(parmTemplateType, 11, HOM_PARM_TYPE_CATEGORY_VALUES)


#define HOM_PARM_LOOK_VALUES \
    Regular, Angle, Vector, ColorSquare, HueCircle, CRGBAPlaneChooser
HOM_DECLARE_ENUM_MODULE(parmLook, 6, HOM_PARM_LOOK_VALUES)


#define HOM_PARM_NAMING_SCHEME_VALUES \
    Base1, XYZW, XYWH, UVW, RGBA, MinMax, MaxMin, StartEnd, BeginEnd
HOM_DECLARE_ENUM_MODULE(parmNamingScheme, 9, HOM_PARM_NAMING_SCHEME_VALUES)


#define HOM_STRING_PARM_TYPE_VALUES \
    Regular, FileReference, NodeReference, NodeReferenceList
HOM_DECLARE_ENUM_MODULE(stringParmType, 4, HOM_STRING_PARM_TYPE_VALUES)


#define HOM_EXPR_LANGUAGE_VALUES \
    Python, Hscript
HOM_DECLARE_ENUM_MODULE(exprLanguage, 2, HOM_EXPR_LANGUAGE_VALUES)


#define HOM_SCRIPT_LANGUAGE_VALUES \
    Python, Hscript
HOM_DECLARE_ENUM_MODULE(scriptLanguage, 2, HOM_SCRIPT_LANGUAGE_VALUES)


#define HOM_FILE_TYPE_VALUES \
    Any, Image, Geometry, Ramp, Capture, Clip, Lut, Cmd, Midi, I3d, Chan, \
    Sim, SimData, Hip, Otl, Dae, Gallery, Directory
HOM_DECLARE_ENUM_MODULE(fileType, 18, HOM_FILE_TYPE_VALUES)


#define HOM_FILE_CHOOSER_MODE_VALUES \
    Read, Write, ReadAndWrite
HOM_DECLARE_ENUM_MODULE(fileChooserMode, 3, HOM_FILE_CHOOSER_MODE_VALUES)


#define HOM_FOLDER_TYPE_VALUES \
    Tabs, RadioButtons, MultiparmBlock, ScrollingMultiparmBlock, \
    TabbedMultiparmBlock, ImportBlock
HOM_DECLARE_ENUM_MODULE(folderType, 6, HOM_FOLDER_TYPE_VALUES)


#define HOM_MENU_TYPE_VALUES \
    Normal, Mini, StringReplace, StringToggle
HOM_DECLARE_ENUM_MODULE(menuType, 4, HOM_MENU_TYPE_VALUES)


#define HOM_PANE_TAB_TYPE_VALUES \
    SceneViewer, ContextViewer, ChannelViewer, CompositorViewer, \
    ParticleViewer, \
    OutputViewer, MaterialPalette, ShaderViewer, IPRViewer, \
    NetworkEditor, Parm, \
    DetailsView, ChannelEditor, ChannelList, Textport, PythonShell, \
    HandleList, BundleList, TakeList, TreeView, HelpBrowser, ParmSpreadsheet, \
    LightLinker
HOM_DECLARE_ENUM_MODULE(paneTabType, 23, HOM_PANE_TAB_TYPE_VALUES)


#define HOM_PANE_LINK_TYPE_VALUES \
    Pinned, Group1, Group2, Group3, Group4, Group5, Group6, Group7, Group8, \
    Group9, FollowSelection
HOM_DECLARE_ENUM_MODULE(paneLinkType, 11, HOM_PANE_LINK_TYPE_VALUES)


#define HOM_GEOMETRY_VIEWPORT_TYPE_VALUES \
    Perspective, Top, Bottom, Front, Back, Right, Left, UV
HOM_DECLARE_ENUM_MODULE(geometryViewportType, 8, \
    HOM_GEOMETRY_VIEWPORT_TYPE_VALUES)


#define HOM_GL_SHADING_TYPE_VALUES \
    WireBoundingBox, ShadedBoundingBox, Wire, HiddenLineInvisible, \
    HiddenLineGhost, Flat, FlatWire, Smooth, SmoothWire
HOM_DECLARE_ENUM_MODULE(glShadingType, 9, HOM_GL_SHADING_TYPE_VALUES)


#define HOM_GEOMETRY_VIEWPORT_LAYOUT_VALUES \
    Single, Quad, DoubleStack, DoubleSide, TripleBottomSplit, \
    TripleLeftSplit, QuadBottomSplit, QuadLeftSplit
HOM_DECLARE_ENUM_MODULE(geometryViewportLayout, 8, \
    HOM_GEOMETRY_VIEWPORT_LAYOUT_VALUES)


#define HOM_SNAPPING_MODE_VALUES \
    Off, Grid, Prim, Point, Multi
HOM_DECLARE_ENUM_MODULE(snappingMode, 5, HOM_SNAPPING_MODE_VALUES)


#define HOM_GEOMETRY_TYPE_VALUES \
    Points, Vertices, Edges, Breakpoints, Primitives, \
    PointGroups, PrimitiveGroups
HOM_DECLARE_ENUM_MODULE(geometryType, 7, HOM_GEOMETRY_TYPE_VALUES)


#define HOM_CONNECTIVITY_TYPE_VALUES \
    NoConnectivity, Texture, Position
HOM_DECLARE_ENUM_MODULE(connectivityType, 3, HOM_CONNECTIVITY_TYPE_VALUES)


#define HOM_SEVERITY_TYPE_VALUES \
    Message, ImportantMessage, Warning, Error, Fatal
HOM_DECLARE_ENUM_MODULE(severityType, 5, HOM_SEVERITY_TYPE_VALUES)


#define HOM_POSITION_TYPE_VALUES \
    WorldSpace, ViewportXY, ViewportUV
HOM_DECLARE_ENUM_MODULE(positionType, 3, HOM_POSITION_TYPE_VALUES)


// Boost has a limit of 25 on the size of a tuple, so we need to use a sequence
// for this enumeration.  Swig can't handle sequences, though, so we need
// to use the tuple version for it.
#ifndef SWIG
#define HOM_SHADER_TYPE_SEQ \
    (Surface)(SurfaceShadow)(Displacement)(Geometry)(Interior)(Light)\
    (LightShadow)(Atmosphere)(Lens)(Output)(Background)(Photon)\
    (MentalRayEmitter)(MentalRayPhotonVolume)(MentalRayEnvironment)\
    (MentalRayContour)(MentalRayContourStore)(MentalRayContourContrast)\
    (MentalRayTextureContrast)(Image3D)(CVex)(CoShader)(Mutable)\
    (Properties)(Material)(VopMaterial)
HOM_DECLARE_ENUM_MODULE_FROM_SEQ(shaderType, HOM_SHADER_TYPE_SEQ)
#else
#define HOM_SHADER_TYPE_VALUES \
    Surface, SurfaceShadow, Displacement, Geometry, Interior, Light, \
    LightShadow, Atmosphere, Lens, Output, Background, Photon, \
    MentalRayEmitter, MentalRayPhotonVolume, MentalRayEnvironment, \
    MentalRayContour, MentalRayContourStore, MentalRayContourContrast, \
    MentalRayTextureContrast, Image3D, CVex, CoShader, Mutable, \
    Properties, Material, VopMaterial
HOM_DECLARE_ENUM_MODULE(shaderType, 26, HOM_SHADER_TYPE_VALUES)
#endif


#define HOM_RAMP_BASIS_VALUES \
    Constant, Linear, CatmullRom, MonotoneCubic
HOM_DECLARE_ENUM_MODULE(rampBasis, 4, HOM_RAMP_BASIS_VALUES)


#define HOM_RAMP_PARM_TYPE_VALUES \
    Color, Float
HOM_DECLARE_ENUM_MODULE(rampParmType, 2, HOM_RAMP_PARM_TYPE_VALUES)


#define HOM_COLOR_TYPE_VALUES \
    HSL, HSV, RGB, XYZ, LAB
HOM_DECLARE_ENUM_MODULE(colorType, 5, HOM_COLOR_TYPE_VALUES)


#define HOM_NODE_TYPE_SOURCE_VALUES \
    Internal, Subnet, CompiledCode, VexCode, RslCode
HOM_DECLARE_ENUM_MODULE(nodeTypeSource, 5, HOM_NODE_TYPE_SOURCE_VALUES)


#define HOM_FIELD_TYPE_VALUES \
    NoSuchField, Integer, Boolean, Float, String, \
    Vector2, Vector3, Vector4, Quaternion, \
    Matrix3, Matrix4, UV, UVW
HOM_DECLARE_ENUM_MODULE(fieldType, 13, HOM_FIELD_TYPE_VALUES)


#define HOM_RENDER_METHOD_VALUES \
    RopByRop, FrameByFrame
HOM_DECLARE_ENUM_MODULE(renderMethod, 2, HOM_RENDER_METHOD_VALUES)


#define HOM_UPDATE_MODE_VALUES \
    AutoUpdate, OnMouseUp, Manual
HOM_DECLARE_ENUM_MODULE(updateMode, 3, HOM_UPDATE_MODE_VALUES)


#define HOM_LICENSE_CATEGORY_TYPE_VALUES \
    Commercial, Education, ApprenticeHD, Apprentice
HOM_DECLARE_ENUM_MODULE(licenseCategoryType, 4, HOM_LICENSE_CATEGORY_TYPE_VALUES)


#define HOM_HDA_LICENSE_TYPE_VALUES \
    Execute, Read, Full
HOM_DECLARE_ENUM_MODULE(hdaLicenseType, 3, HOM_HDA_LICENSE_TYPE_VALUES)


#define HOM_ORIENTATION_UPAXIS_VALUES \
    Y, Z
HOM_DECLARE_ENUM_MODULE(orientUpAxis, 2, HOM_ORIENTATION_UPAXIS_VALUES)


#define HOM_NODE_EVENT_TYPE_VALUES \
    BeingDeleted, NameChanged, InputRewired, FlagChanged, ParmTupleChanged, \
    AppearanceChanged, PositionChanged, ChildCreated, ChildDeleted, \
    ChildSwitched, ChildSelectionChanged
HOM_DECLARE_ENUM_MODULE(nodeEventType, 11, HOM_NODE_EVENT_TYPE_VALUES)


// Boost has a limit of 25 on the size of a tuple, so we need to use a sequence
// for this enumeration.  Swig can't handle sequences, though, so we need
// to use the tuple version for it.
#ifndef SWIG
#define HOM_NODE_TYPE_FILTER_SEQ \
    (NoFilter)(Sop)(Pop)(Popnet)(Chop)(Chopnet)(Cop)(Copnet)(Vop)(Vopnet) \
    (Rop)(Obj)(ObjGeometry)(ObjFog)(ObjGeometryOrFog)(ObjLight)(ObjCamera) \
    (ObjBone)(ObjMuscle)(ObjSubnet)(Shop)(ShopMaterial)(ShopProperties) \
    (ShopSurface)(ShopDisplacement)(ShopInterior)(ShopLight)(ShopLightShadow) \
    (ShopAtmosphere)(ShopPhoton)(ShopImage3D)(ShopCVEX)
HOM_DECLARE_ENUM_MODULE_FROM_SEQ(nodeTypeFilter, HOM_NODE_TYPE_FILTER_SEQ)
#else
#define HOM_NODE_TYPE_FILTER_VALUES \
    NoFilter, Sop, Pop, Popnet, Chop, Chopnet, Cop, Copnet, Vop, Vopnet, \
    Rop, Obj, ObjGeometry, ObjFog, ObjGeometryOrFog, ObjLight, ObjCamera, \
    ObjBone, ObjMuscle, ObjSubnet, Shop, ShopMaterial, ShopProperties, \
    ShopSurface, ShopDisplacement, ShopInterior, ShopLight, ShopLightShadow, \
    ShopAtmosphere, ShopPhoton, ShopImage3D, ShopCVEX
HOM_DECLARE_ENUM_MODULE(nodeTypeFilter, 32, HOM_NODE_TYPE_FILTER_VALUES)
#endif

#endif

---