SketchUp SDK
|
#include <slapi/color.h>
#include <slapi/slapi.h>
#include <slapi/unicodestring.h>
#include <slapi/model/defs.h>
Go to the source code of this file.
Enumerations | |
enum | SUTypedValueType { SUTypedValueType_Empty = 0, SUTypedValueType_Byte, SUTypedValueType_Short, SUTypedValueType_Int32, SUTypedValueType_Float, SUTypedValueType_Double, SUTypedValueType_Bool, SUTypedValueType_Color, SUTypedValueType_Time, SUTypedValueType_String, SUTypedValueType_Vector3D, SUTypedValueType_Array } |
The set of types that a SUTypedValueRef can represent. More... | |
Functions | |
SU_RESULT | SUTypedValueCreate (SUTypedValueRef *typed_value) |
Creates a typed value object. The created object must be released with SUTypedValueRelease. More... | |
SU_RESULT | SUTypedValueRelease (SUTypedValueRef *typed_value) |
Releases a typed value object that was previously created with SUTypedValueCreate. More... | |
SU_RESULT | SUTypedValueGetType (SUTypedValueRef typed_value, enum SUTypedValueType *type) |
Retrieves the type information of a typed value object. More... | |
SU_RESULT | SUTypedValueGetByte (SUTypedValueRef typed_value, char *byte_value) |
Retrieves the byte value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetByte (SUTypedValueRef typed_value, char byte_value) |
Sets the byte value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetInt16 (SUTypedValueRef typed_value, int16_t *int16_value) |
Retrieves the int16 value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetInt16 (SUTypedValueRef typed_value, int16_t int16_value) |
Sets the int16 value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetInt32 (SUTypedValueRef typed_value, int32_t *int32_value) |
Retrieves the int32 value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetInt32 (SUTypedValueRef typed_value, int32_t int32_value) |
Sets the int32 value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetFloat (SUTypedValueRef typed_value, float *float_value) |
Retrieves the float value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetFloat (SUTypedValueRef typed_value, float float_value) |
Sets the float value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetDouble (SUTypedValueRef typed_value, double *double_value) |
Retrieves the double value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetDouble (SUTypedValueRef typed_value, double double_value) |
Sets the double value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetBool (SUTypedValueRef typed_value, bool *bool_value) |
Retrieves the boolean value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetBool (SUTypedValueRef typed_value, bool bool_value) |
Sets the boolean value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetColor (SUTypedValueRef typed_value, SUColor *color) |
Retrieves the color value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetColor (SUTypedValueRef typed_value, const SUColor *color) |
Sets the color value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetTime (SUTypedValueRef typed_value, int64_t *time_value) |
Retrieves the time value of a typed value object. The time value is in seconds since January 1, 1970. More... | |
SU_RESULT | SUTypedValueSetTime (SUTypedValueRef typed_value, int64_t time_value) |
Sets the time value of a typed value object. The time value is in seconds since January 1, 1970. More... | |
SU_RESULT | SUTypedValueGetString (SUTypedValueRef typed_value, SUStringRef *string_value) |
Retrieves the string value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetString (SUTypedValueRef typed_value, const char *string_value) |
Sets the string value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetVector3d (SUTypedValueRef typed_value, double vector3d_value[3]) |
Retrieves the 3-element vector value of a typed value object. More... | |
SU_RESULT | SUTypedValueSetVector3d (SUTypedValueRef typed_value, const double vector3d_value[3]) |
Sets the 3-element vector value of a typed value object. More... | |
SU_RESULT | SUTypedValueGetArrayItems (SUTypedValueRef typed_value, size_t len, SUTypedValueRef values[], size_t *count) |
Retrieve the array of typed value objects of a type value object. More... | |
SU_RESULT | SUTypedValueSetArrayItems (SUTypedValueRef typed_value, size_t len, SUTypedValueRef values[]) |
Sets the array of typed value objects of a typed value object. The elements of the given array are copied to the type value object. More... | |
SU_RESULT | SUTypedValueGetNumArrayItems (SUTypedValueRef typed_value, size_t *count) |
Retrieves the number of typed value objects of a typed value object. More... | |
enum SUTypedValueType |
The set of types that a SUTypedValueRef can represent.
SU_RESULT SUTypedValueCreate | ( | SUTypedValueRef * | typed_value | ) |
Creates a typed value object. The created object must be released with SUTypedValueRelease.
[out] | typed_value | The created typed value object. |
SU_RESULT SUTypedValueGetArrayItems | ( | SUTypedValueRef | typed_value, |
size_t | len, | ||
SUTypedValueRef | values[], | ||
size_t * | count | ||
) |
Retrieve the array of typed value objects of a type value object.
[in] | typed_value | The typed value object. |
[in] | len | The length of the array to retrieve. |
[out] | values | The typed value objects retrieved. |
[out] | count | The actual number of typed value objects retrieved. |
SU_RESULT SUTypedValueGetBool | ( | SUTypedValueRef | typed_value, |
bool * | bool_value | ||
) |
Retrieves the boolean value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | bool_value | The boolean value retrieved. |
SU_RESULT SUTypedValueGetByte | ( | SUTypedValueRef | typed_value, |
char * | byte_value | ||
) |
Retrieves the byte value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | byte_value | The byte value retrieved. |
SU_RESULT SUTypedValueGetColor | ( | SUTypedValueRef | typed_value, |
SUColor * | color | ||
) |
Retrieves the color value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | color | The color value retrieved. |
SU_RESULT SUTypedValueGetDouble | ( | SUTypedValueRef | typed_value, |
double * | double_value | ||
) |
Retrieves the double value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | double_value | The double value retrieved. |
SU_RESULT SUTypedValueGetFloat | ( | SUTypedValueRef | typed_value, |
float * | float_value | ||
) |
Retrieves the float value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | float_value | The float value retrieved. |
SU_RESULT SUTypedValueGetInt16 | ( | SUTypedValueRef | typed_value, |
int16_t * | int16_value | ||
) |
Retrieves the int16 value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | int16_value | The int16 value retrieved. |
SU_RESULT SUTypedValueGetInt32 | ( | SUTypedValueRef | typed_value, |
int32_t * | int32_value | ||
) |
Retrieves the int32 value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | int32_value | The int32 value retrieved. |
SU_RESULT SUTypedValueGetNumArrayItems | ( | SUTypedValueRef | typed_value, |
size_t * | count | ||
) |
Retrieves the number of typed value objects of a typed value object.
[in] | typed_value | The typed value object. |
[out] | count | The number of typed value objects in the array. |
SU_RESULT SUTypedValueGetString | ( | SUTypedValueRef | typed_value, |
SUStringRef * | string_value | ||
) |
Retrieves the string value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | string_value | The string value retrieved. |
SU_RESULT SUTypedValueGetTime | ( | SUTypedValueRef | typed_value, |
int64_t * | time_value | ||
) |
Retrieves the time value of a typed value object. The time value is in seconds since January 1, 1970.
[in] | typed_value | The typed value object. |
[out] | time_value | The time value retrieved. |
SU_RESULT SUTypedValueGetType | ( | SUTypedValueRef | typed_value, |
enum SUTypedValueType * | type | ||
) |
Retrieves the type information of a typed value object.
[in] | typed_value | The typed value object. |
[out] | type | The type information retrieved. |
SU_RESULT SUTypedValueGetVector3d | ( | SUTypedValueRef | typed_value, |
double | vector3d_value[3] | ||
) |
Retrieves the 3-element vector value of a typed value object.
[in] | typed_value | The typed value object. |
[out] | vector3d_value | The 3-element vector value retrieved. |
SU_RESULT SUTypedValueRelease | ( | SUTypedValueRef * | typed_value | ) |
Releases a typed value object that was previously created with SUTypedValueCreate.
[in] | typed_value | The typed value object. |
SU_RESULT SUTypedValueSetArrayItems | ( | SUTypedValueRef | typed_value, |
size_t | len, | ||
SUTypedValueRef | values[] | ||
) |
Sets the array of typed value objects of a typed value object. The elements of the given array are copied to the type value object.
[in] | typed_value | The typed value object. |
[in] | len | The number of typed value objects to set. |
[in] | values | The array of typed value objects to set. |
SU_RESULT SUTypedValueSetBool | ( | SUTypedValueRef | typed_value, |
bool | bool_value | ||
) |
Sets the boolean value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | bool_value | The boolean value to set. |
SU_RESULT SUTypedValueSetByte | ( | SUTypedValueRef | typed_value, |
char | byte_value | ||
) |
Sets the byte value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | byte_value | The byte value that is assigned. |
SU_RESULT SUTypedValueSetColor | ( | SUTypedValueRef | typed_value, |
const SUColor * | color | ||
) |
Sets the color value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | color | The color value to set. |
SU_RESULT SUTypedValueSetDouble | ( | SUTypedValueRef | typed_value, |
double | double_value | ||
) |
Sets the double value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | double_value | The double value to set. |
SU_RESULT SUTypedValueSetFloat | ( | SUTypedValueRef | typed_value, |
float | float_value | ||
) |
Sets the float value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | float_value | The float value to set. |
SU_RESULT SUTypedValueSetInt16 | ( | SUTypedValueRef | typed_value, |
int16_t | int16_value | ||
) |
Sets the int16 value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | int16_value | The int16 value to set. |
SU_RESULT SUTypedValueSetInt32 | ( | SUTypedValueRef | typed_value, |
int32_t | int32_value | ||
) |
Sets the int32 value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | int32_value | The int32 value to set. |
SU_RESULT SUTypedValueSetString | ( | SUTypedValueRef | typed_value, |
const char * | string_value | ||
) |
Sets the string value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | string_value | The string value to set. Assumed to be UTF-8 encoded. |
SU_RESULT SUTypedValueSetTime | ( | SUTypedValueRef | typed_value, |
int64_t | time_value | ||
) |
Sets the time value of a typed value object. The time value is in seconds since January 1, 1970.
[in] | typed_value | The typed value object. |
[in] | time_value | The time value that is set. |
SU_RESULT SUTypedValueSetVector3d | ( | SUTypedValueRef | typed_value, |
const double | vector3d_value[3] | ||
) |
Sets the 3-element vector value of a typed value object.
[in] | typed_value | The typed value object. |
[in] | vector3d_value | The 3-element vector value to set. |