HDK: CHOP/PRM_ChopShared.h Source File

00001 /*
00002  * PROPRIETARY INFORMATION.  This software is proprietary to
00003  * Side Effects Software Inc., and is not to be reproduced,
00004  * transmitted, or disclosed in any way without written permission.
00005  *
00006  * Produced by:
00007  *      Mark Alexander 
00008  *      Side Effects Software Inc.
00009  *      477 Richmond Street West
00010  *      Toronto, Ontario
00011  *      Canada   M5V 3E7
00012  *      416-504-9876
00013  *
00014  * NAME:        CHOP Library (C++)
00015  *
00016  * COMMENTS:    Common UI definitions
00017  *
00018  */
00019 
00020 #ifndef __CHOP_ChopShared_H__
00021 #define __CHOP_ChopShared_H__
00022 
00023 #include "CHOP_API.h"
00024 #include <PRM/PRM_ChoiceList.h>
00025 #include <PRM/PRM_Range.h>
00026 #include <PRM/PRM_Default.h>
00027 
00028 // menu enumerations
00029 
00030 enum
00031 {
00032     ACTIVE_OFF          = 0,
00033     ACTIVE_ON           = 1,
00034     ACTIVE_MOMENTARY    = 2,
00035     ACTIVE_TOGGLE       = 3
00036 };
00037 
00038 enum
00039 {
00040     SHIFT_FORWARD       = 0,
00041     SHIFT_BACKWARD      = 1,
00042     SHIFT_OFF           = 2
00043 };
00044 
00045 enum
00046 {
00047     TYPE_RAW            = 0,
00048     TYPE_SPEEDRAW       = 1,
00049     TYPE_POSITION       = 2,
00050     TYPE_SPEED          = 3,
00051     TYPE_SPEEDHOLD      = 4
00052 };
00053 
00054 enum
00055 {
00056     UNITS_ABSOLUTE      = 0,
00057     UNITS_RELATIVE      = 1,
00058     UNITS_CURRENT       = 2
00059 };
00060 
00061 enum
00062 {
00063     RECORD_OFF          = 0,
00064     RECORD_ON           = 1,
00065     RECORD_ADD          = 2,
00066     RECORD_AUTO_RANGE   = 3,
00067     RECORD_SINGLE       = 4
00068 };
00069 
00070 enum
00071 {
00072     REMAINDER_DISCARD   = 0,
00073     REMAINDER_EXTEND    = 1,
00074     REMAINDER_ADD       = 2
00075 };
00076 
00077 enum
00078 {
00079     MATCH_NUMBER        = 0,
00080     MATCH_NAME          = 1,
00081     MATCH_UNION         = 2
00082 };
00083 enum
00084 {
00085     RANGE_FULL_ANIMATION    = 0,
00086     RANGE_CURRENT_FRAME     = 1,
00087     RANGE_USER_ENTERED      = 2,
00088     RANGE_NUM_ITEMS     // sentinel
00089 };
00090 
00091 
00092 // Some common menu defs
00093 CHOP_API extern PRM_ChoiceList          CHOP_AlignMenu;
00094 CHOP_API extern PRM_ChoiceList          CHOP_BlendFunctionMenu;
00095 CHOP_API extern PRM_ChoiceList          CHOP_BlendMethodMenu;
00096 CHOP_API extern PRM_ChoiceList          CHOP_ExtendMenu;
00097 CHOP_API extern PRM_ChoiceList          CHOP_ExtendFullMenu;
00098 CHOP_API extern PRM_ChoiceList          CHOP_FilterChunkMenu;
00099 CHOP_API extern PRM_ChoiceList          CHOP_MatchMenu;
00100 CHOP_API extern PRM_ChoiceList          CHOP_Match2Menu;
00101 CHOP_API extern PRM_ChoiceList          CHOP_OrderMenu;
00102 CHOP_API extern PRM_ChoiceList          CHOP_RelativeMenu;
00103 CHOP_API extern PRM_ChoiceList          CHOP_Relative2Menu;
00104 CHOP_API extern PRM_ChoiceList          CHOP_Relative3Menu;
00105 CHOP_API extern PRM_ChoiceList          CHOP_InterpolateMenu;
00106 CHOP_API extern PRM_ChoiceList          CHOP_RemainderMenu;
00107 CHOP_API extern PRM_ChoiceList          CHOP_RangeMenu;
00108 
00109 // Beat box menus
00110 CHOP_API extern PRM_ChoiceList          CHOP_ActiveMenu;
00111 CHOP_API extern PRM_ChoiceList          CHOP_KeyMenu;
00112 CHOP_API extern PRM_ChoiceList          CHOP_TypeMenu;
00113 CHOP_API extern PRM_ChoiceList          CHOP_LimitMenu;
00114 CHOP_API extern PRM_ChoiceList          CHOP_RecordMenu;
00115 
00116 // Ranges
00117 CHOP_API extern PRM_Range               CHOP_BiasRange;
00118 CHOP_API extern PRM_Range               CHOP_CycleLengthRange;
00119 CHOP_API extern PRM_Range               CHOP_DefaultValueRange;
00120 CHOP_API extern PRM_Range       CHOP_DoubleFrameRange;
00121 CHOP_API extern PRM_Range       CHOP_FrameRange;
00122 CHOP_API extern PRM_Range               CHOP_OverlapChunkRange;
00123 CHOP_API extern PRM_Range       CHOP_PosFrameRange;
00124 CHOP_API extern PRM_Range               CHOP_SampleRateRange;
00125 CHOP_API extern PRM_Range               CHOP_StepRange;
00126 
00127 // Defaults
00128 CHOP_API extern PRM_Default             CHOP_BiasDefault;
00129 CHOP_API extern PRM_Default             CHOP_BlendFunctionDefault;
00130 CHOP_API extern PRM_Default             CHOP_ChunkDiscardDefault;
00131 CHOP_API extern PRM_Default             CHOP_CycleLengthDefault;
00132 CHOP_API extern PRM_Default             CHOP_EndDefault;
00133 CHOP_API extern PRM_Default             CHOP_FilterChunkDefault;
00134 CHOP_API extern PRM_Default             CHOP_HalfWayDefault;
00135 CHOP_API extern PRM_Default             CHOP_OverlapChunkDefault;
00136 CHOP_API extern PRM_Default             CHOP_SampleRateDefault;
00137 CHOP_API extern PRM_Default             CHOP_StartDefault;
00138 CHOP_API extern PRM_Default             CHOP_ScopeDefault;
00139 CHOP_API extern PRM_Default             CHOP_RelativeDefault;
00140 CHOP_API extern PRM_Default             CHOP_InterpolateDefault;
00141 
00142 // Beatbox Defaults
00143 CHOP_API extern PRM_Default             CHOP_ActiveDefault;
00144 CHOP_API extern PRM_Default             CHOP_TypeDefault;
00145 CHOP_API extern PRM_Default             CHOP_KeyDefault[];
00146 CHOP_API extern PRM_Default             CHOP_LimitDefault;
00147 CHOP_API extern PRM_Default             CHOP_RecordDefault;
00148 CHOP_API extern PRM_Default             CHOP_RemainderDefault;
00149 CHOP_API extern PRM_Default             CHOP_RotScopeDefault;
00150 CHOP_API extern PRM_Default             CHOP_RXScopeDefault;
00151 CHOP_API extern PRM_Default             CHOP_RYScopeDefault;
00152 CHOP_API extern PRM_Default             CHOP_RZScopeDefault;
00153 
00154 // Names
00155 CHOP_API extern PRM_Name                        CHOP_AlignName;
00156 CHOP_API extern PRM_Name                        CHOP_BiasName;
00157 CHOP_API extern PRM_Name                        CHOP_BlendFunctionName;
00158 CHOP_API extern PRM_Name                        CHOP_BlendMethodName;
00159 CHOP_API extern PRM_Name                        CHOP_BlendRegionName;
00160 CHOP_API extern PRM_Name                        CHOP_BlendStepScopeName;
00161 CHOP_API extern PRM_Name                        CHOP_ConstantAreaName;
00162 CHOP_API extern PRM_Name                        CHOP_CycleLengthName;
00163 CHOP_API extern PRM_Name                        CHOP_DefaultValueName;
00164 CHOP_API extern PRM_Name                        CHOP_ExtendLeftName;
00165 CHOP_API extern PRM_Name                        CHOP_ExtendRightName;
00166 CHOP_API extern PRM_Name                        CHOP_MatchName;
00167 CHOP_API extern PRM_Name                        CHOP_OrderName;
00168 CHOP_API extern PRM_Name                        CHOP_RelativeName;
00169 CHOP_API extern PRM_Name                        CHOP_BlendStepName;
00170 CHOP_API extern PRM_Name                        CHOP_SampleRateName;
00171 CHOP_API extern PRM_Name                        CHOP_InterpolateName;
00172 CHOP_API extern PRM_Name                        CHOP_RemainderName;
00173 CHOP_API extern PRM_Name                        CHOP_RangeName;
00174 
00175 CHOP_API extern PRM_Name                        CHOP_QuaternionName;
00176 CHOP_API extern PRM_Name                        CHOP_RXScopeName;
00177 CHOP_API extern PRM_Name                        CHOP_RYScopeName;
00178 CHOP_API extern PRM_Name                        CHOP_RZScopeName;
00179 CHOP_API extern PRM_Name                        CHOP_ShortRotName;
00180 CHOP_API extern PRM_Name                        CHOP_RotScopeName;
00181 
00182 CHOP_API extern PRM_Name                        CHOP_StartName;
00183 CHOP_API extern PRM_Name                        CHOP_EndName;
00184 CHOP_API extern PRM_Name                        CHOP_SingleFrameName;
00185 
00186 
00187 // Beatbox Names
00188 CHOP_API extern PRM_Name                        CHOP_ActiveName;
00189 CHOP_API extern PRM_Name                        CHOP_RecordName;
00190 CHOP_API extern PRM_Name                        CHOP_KeyName;
00191 CHOP_API extern PRM_Name                        CHOP_TypeName;
00192 CHOP_API extern PRM_Name                        CHOP_LimitName;
00193 
00194 
00195 // Conversion functions
00196 CHOP_API int                    convertExtendFullMenu(int index);
00197 CHOP_API int                    convertKeyMenu(int index);
00198 
00199 #endif