SketchUp SDK
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Enumerations | Functions
typed_value.h File Reference
#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...
 

Enumeration Type Documentation

The set of types that a SUTypedValueRef can represent.

Enumerator
SUTypedValueType_Empty 
SUTypedValueType_Byte 
SUTypedValueType_Short 
SUTypedValueType_Int32 
SUTypedValueType_Float 
SUTypedValueType_Double 
SUTypedValueType_Bool 
SUTypedValueType_Color 
SUTypedValueType_Time 
SUTypedValueType_String 
SUTypedValueType_Vector3D 
SUTypedValueType_Array 

Function Documentation

SU_RESULT SUTypedValueCreate ( SUTypedValueRef typed_value)

Creates a typed value object. The created object must be released with SUTypedValueRelease.

Parameters
[out]typed_valueThe created typed value object.
Returns
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.

Parameters
[in]typed_valueThe typed value object.
[in]lenThe length of the array to retrieve.
[out]valuesThe typed value objects retrieved.
[out]countThe actual number of typed value objects retrieved.
Returns
SU_RESULT SUTypedValueGetBool ( SUTypedValueRef  typed_value,
bool *  bool_value 
)

Retrieves the boolean value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]bool_valueThe boolean value retrieved.
Returns
SU_RESULT SUTypedValueGetByte ( SUTypedValueRef  typed_value,
char *  byte_value 
)

Retrieves the byte value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]byte_valueThe byte value retrieved.
Returns
SU_RESULT SUTypedValueGetColor ( SUTypedValueRef  typed_value,
SUColor color 
)

Retrieves the color value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]colorThe color value retrieved.
Returns
SU_RESULT SUTypedValueGetDouble ( SUTypedValueRef  typed_value,
double *  double_value 
)

Retrieves the double value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]double_valueThe double value retrieved.
Returns
SU_RESULT SUTypedValueGetFloat ( SUTypedValueRef  typed_value,
float *  float_value 
)

Retrieves the float value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]float_valueThe float value retrieved.
Returns
SU_RESULT SUTypedValueGetInt16 ( SUTypedValueRef  typed_value,
int16_t *  int16_value 
)

Retrieves the int16 value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]int16_valueThe int16 value retrieved.
Returns
SU_RESULT SUTypedValueGetInt32 ( SUTypedValueRef  typed_value,
int32_t *  int32_value 
)

Retrieves the int32 value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]int32_valueThe int32 value retrieved.
Returns
SU_RESULT SUTypedValueGetNumArrayItems ( SUTypedValueRef  typed_value,
size_t *  count 
)

Retrieves the number of typed value objects of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]countThe number of typed value objects in the array.
Returns
SU_RESULT SUTypedValueGetString ( SUTypedValueRef  typed_value,
SUStringRef string_value 
)

Retrieves the string value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]string_valueThe string value retrieved.
Returns
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.

Parameters
[in]typed_valueThe typed value object.
[out]time_valueThe time value retrieved.
Returns
SU_RESULT SUTypedValueGetType ( SUTypedValueRef  typed_value,
enum SUTypedValueType type 
)

Retrieves the type information of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]typeThe type information retrieved.
Returns
SU_RESULT SUTypedValueGetVector3d ( SUTypedValueRef  typed_value,
double  vector3d_value[3] 
)

Retrieves the 3-element vector value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[out]vector3d_valueThe 3-element vector value retrieved.
Returns
SU_RESULT SUTypedValueRelease ( SUTypedValueRef typed_value)

Releases a typed value object that was previously created with SUTypedValueCreate.

Parameters
[in]typed_valueThe typed value object.
Returns
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.

Parameters
[in]typed_valueThe typed value object.
[in]lenThe number of typed value objects to set.
[in]valuesThe array of typed value objects to set.
Returns
SU_RESULT SUTypedValueSetBool ( SUTypedValueRef  typed_value,
bool  bool_value 
)

Sets the boolean value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]bool_valueThe boolean value to set.
Returns
SU_RESULT SUTypedValueSetByte ( SUTypedValueRef  typed_value,
char  byte_value 
)

Sets the byte value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]byte_valueThe byte value that is assigned.
Returns
SU_RESULT SUTypedValueSetColor ( SUTypedValueRef  typed_value,
const SUColor color 
)

Sets the color value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]colorThe color value to set.
Returns
SU_RESULT SUTypedValueSetDouble ( SUTypedValueRef  typed_value,
double  double_value 
)

Sets the double value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]double_valueThe double value to set.
Returns
SU_RESULT SUTypedValueSetFloat ( SUTypedValueRef  typed_value,
float  float_value 
)

Sets the float value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]float_valueThe float value to set.
Returns
SU_RESULT SUTypedValueSetInt16 ( SUTypedValueRef  typed_value,
int16_t  int16_value 
)

Sets the int16 value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]int16_valueThe int16 value to set.
Returns
SU_RESULT SUTypedValueSetInt32 ( SUTypedValueRef  typed_value,
int32_t  int32_value 
)

Sets the int32 value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]int32_valueThe int32 value to set.
Returns
SU_RESULT SUTypedValueSetString ( SUTypedValueRef  typed_value,
const char *  string_value 
)

Sets the string value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]string_valueThe string value to set. Assumed to be UTF-8 encoded.
Returns
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.

Parameters
[in]typed_valueThe typed value object.
[in]time_valueThe time value that is set.
Returns
SU_RESULT SUTypedValueSetVector3d ( SUTypedValueRef  typed_value,
const double  vector3d_value[3] 
)

Sets the 3-element vector value of a typed value object.

Parameters
[in]typed_valueThe typed value object.
[in]vector3d_valueThe 3-element vector value to set.
Returns