|
Gocator Development Kit
|
Represents the schema of a configurable parameter.
Public Member Functions | |
| kStatus | GdkParamInfo_AddDataType (GdkParamInfo info, GdkDataType type) |
| If the parameter is a Multiple Data Type Input, add an accepted data type. More... | |
| kStatus | GdkParamInfo_AddOptionFloat (GdkParamInfo info, k64f option, const kChar *name) |
| Add an option for an float parameter. More... | |
| kStatus | GdkParamInfo_AddOptionInt (GdkParamInfo info, k32s option, const kChar *name) |
| Add an option for an integer parameter. More... | |
| kStatus | GdkParamInfo_AddSource (GdkParamInfo info, GdkDataSource source) |
| Adds the source perspective of the data to list of source perspectives This is only applicable to parameters of type DataInput and will automatically have GDK_DATA_SOURCE_TOP added for parameters of this type. More... | |
| kStatus | GdkParamInfo_ClearOptions (GdkParamInfo info) |
| Clears all options for the parameter. More... | |
| kBool | GdkParamInfo_ConfigOptional (GdkParamInfo info) |
| Returns whether or not the parameter is optional. More... | |
| kStatus | GdkParamInfo_EnableSurfaceRegionZAngle (GdkParamInfo info) |
| Enables Z angle support for the surface region passed. More... | |
| kBool | GdkParamInfo_IsInputData (GdkParamInfo info) |
| Returns whether the info object is of type input data set. More... | |
| kBool | GdkParamInfo_IsOptional (GdkParamInfo info) |
| [Deprecated] Use GdkParamInfo_ConfigOptional() instead. More... | |
| const kChar * | GdkParamInfo_Label (GdkParamInfo info) |
| Returns the display label of the parameter. More... | |
| k64f | GdkParamInfo_MaxFloat (GdkParamInfo info) |
| Returns the maximum value for a decimal parameter. More... | |
| k32s | GdkParamInfo_MaxInt (GdkParamInfo info) |
| Returns the maximum value for an integer parameter. More... | |
| k64f | GdkParamInfo_MinFloat (GdkParamInfo info) |
| Returns the minimum value for a decimal parameter. More... | |
| k32s | GdkParamInfo_MinInt (GdkParamInfo info) |
| Returns the minimum value for an integer parameter. More... | |
| const kChar * | GdkParamInfo_Name (GdkParamInfo info) |
| Returns the name of the parameter. More... | |
| kBool | GdkParamInfo_NoneAllowed (GdkParamInfo info) |
| Returns whether the input parameter can be set to None or requires an actual data input. More... | |
| k64f | GdkParamInfo_OptionAtFloat (GdkParamInfo info, kSize index) |
| Returns the option at a specified index for an float parameter. More... | |
| k32s | GdkParamInfo_OptionAtInt (GdkParamInfo info, kSize index) |
| Returns the option at a specified index for an integer parameter. More... | |
| kSize | GdkParamInfo_OptionCount (GdkParamInfo info) |
| Returns the number of options for the parameter. More... | |
| const kChar * | GdkParamInfo_OptionNameAt (GdkParamInfo info, kSize index) |
| Returns the option name at a specified index. More... | |
| kStatus | GdkParamInfo_RemoveOption (GdkParamInfo info, kSize index) |
| Remove the option at a specified index. More... | |
| kStatus | GdkParamInfo_RemoveSource (GdkParamInfo info, GdkDataSource source) |
| Removes the source from the list of source perspectives. More... | |
| kStatus | GdkParamInfo_SetConfigOptional (GdkParamInfo info, kBool optional) |
| Sets a parameter to be optional or not. More... | |
| kStatus | GdkParamInfo_SetDefault (GdkParamInfo info, const void *value) |
| Assign the default value of the parameter to sue when refreshing the parameter. More... | |
| kStatus | GdkParamInfo_SetIsOptional (GdkParamInfo info, kBool optional) |
| [Deprecated] Use GdkParamInfo_SetConfigOptional() instead. More... | |
| kStatus | GdkParamInfo_SetLabel (GdkParamInfo info, const kChar *label) |
| Sets the display label of the parameter. More... | |
| kStatus | GdkParamInfo_SetMaxFloat (GdkParamInfo info, k64f max) |
| Sets the maximum value for a decimal parameter. More... | |
| kStatus | GdkParamInfo_SetMaxInt (GdkParamInfo info, k32s max) |
| Sets the maximum value for an integer parameter. More... | |
| kStatus | GdkParamInfo_SetMinFloat (GdkParamInfo info, k64f min) |
| Sets the minimum value for a decimal parameter. More... | |
| kStatus | GdkParamInfo_SetMinInt (GdkParamInfo info, k32s min) |
| Sets the minimum value for an integer parameter. More... | |
| kStatus | GdkParamInfo_SetName (GdkParamInfo info, const kChar *name) |
| Sets the name of the parameter. More... | |
| kStatus | GdkParamInfo_SetNoneAllowed (GdkParamInfo info, kBool flag) |
| Sets the input parameter to be allowed to be set to None (no argument selected). More... | |
| kStatus | GdkParamInfo_SetUnits (GdkParamInfo info, const kChar *units) |
| Sets the units of the parameter. More... | |
| kArrayList | GdkParamInfo_Sources (GdkParamInfo info) |
| Returns the list of source perspectives of the data. More... | |
| GdkParamType | GdkParamInfo_Type (GdkParamInfo info) |
| Returns the parameter type. More... | |
| const kChar * | GdkParamInfo_Units (GdkParamInfo info) |
| Returns the units of the parameter. More... | |
