SketchUp SDK
|
Go to the source code of this file.
Functions | |
SU_EXPORT SUEntityRef | SUImageToEntity (SUImageRef image) |
Converts from an SUImageRef to an SUEntityRef. This is essentially an upcast operation. More... | |
SU_EXPORT SUImageRef | SUImageFromEntity (SUEntityRef entity) |
Converts from an SUEntityRef to an SUImageRef. This is essentially a downcast operation so the given entity must be convertible to an SUImageRef. More... | |
SU_EXPORT SUDrawingElementRef | SUImageToDrawingElement (SUImageRef image) |
Converts from an SUImageRef to an SUDrawingElementRef. This is essentially an upcast operation. More... | |
SU_EXPORT SUImageRef | SUImageFromDrawingElement (SUDrawingElementRef drawing_elem) |
Converts from an SUDrawingElementRef to an SUImageRef. This is essentially a downcast operation so the given element must be convertible to an SUImageRef. More... | |
SU_RESULT | SUImageCreateFromFile (SUImageRef *image, const char *file_path) |
Creates a new image object from an image file specified by a path. The created image must be subsequently added to the Entities of a model, component definition or a group. More... | |
SU_RESULT | SUImageGetName (SUImageRef image, SUStringRef *name) |
Retrieves the name of an image object. More... | |
SU_RESULT | SUImageSetName (SUImageRef image, const char *name) |
Sets the name of an image object. More... | |
SU_RESULT | SUImageGetTransform (SUImageRef image, struct SUTransformation *transform) |
Retrieves the 3-dimensional homogeneous transform of an image object. More... | |
SU_RESULT | SUImageSetTransform (SUImageRef image, const struct SUTransformation *transform) |
Sets the 3-dimensional homogeneous transform of an image object. More... | |
SU_RESULT | SUImageGetFileName (SUImageRef image, SUStringRef *file_name) |
Retrieves the image file name of an image object. More... | |
SU_RESULT | SUImageGetDimensions (SUImageRef image, double *width, double *height) |
Retrieves the world dimensions of an image object. More... | |
SU_RESULT | SUImageGetPixelDimensions (SUImageRef image, size_t *width, size_t *height) |
Retrieves the width and height dimensions of an image object in pixels. More... | |
SU_RESULT SUImageCreateFromFile | ( | SUImageRef * | image, |
const char * | file_path | ||
) |
Creates a new image object from an image file specified by a path. The created image must be subsequently added to the Entities of a model, component definition or a group.
[out] | image | The image object created. |
file_path | The file path of the source image file. Assumed to be UTF-8 encoded. |
SU_EXPORT SUImageRef SUImageFromDrawingElement | ( | SUDrawingElementRef | drawing_elem | ) |
Converts from an SUDrawingElementRef to an SUImageRef. This is essentially a downcast operation so the given element must be convertible to an SUImageRef.
[in] | drawing_elem | The given element reference. |
SU_EXPORT SUImageRef SUImageFromEntity | ( | SUEntityRef | entity | ) |
Converts from an SUEntityRef to an SUImageRef. This is essentially a downcast operation so the given entity must be convertible to an SUImageRef.
[in] | entity | The given entity reference. |
SU_RESULT SUImageGetDimensions | ( | SUImageRef | image, |
double * | width, | ||
double * | height | ||
) |
Retrieves the world dimensions of an image object.
[in] | image | The image object. |
[out] | width | The width dimension retrieved. |
[out] | height | The height dimension retrieved. |
SU_RESULT SUImageGetFileName | ( | SUImageRef | image, |
SUStringRef * | file_name | ||
) |
Retrieves the image file name of an image object.
[in] | image | The image object. |
[out] | file_name | The image file name retrieved. |
SU_RESULT SUImageGetName | ( | SUImageRef | image, |
SUStringRef * | name | ||
) |
Retrieves the name of an image object.
[in] | image | The image object. |
[out] | name | The name retrieved. |
SU_RESULT SUImageGetPixelDimensions | ( | SUImageRef | image, |
size_t * | width, | ||
size_t * | height | ||
) |
Retrieves the width and height dimensions of an image object in pixels.
[in] | image | The image object. |
[out] | width | The width dimension retrieved. |
[out] | height | The height dimension retrieved. |
SU_RESULT SUImageGetTransform | ( | SUImageRef | image, |
struct SUTransformation * | transform | ||
) |
Retrieves the 3-dimensional homogeneous transform of an image object.
[in] | image | The image object. |
[out] | transform | The transform retrieved. |
SU_RESULT SUImageSetName | ( | SUImageRef | image, |
const char * | name | ||
) |
Sets the name of an image object.
[in] | image | The image object. |
[in] | name | The name to set. Assumed to be UTF-8 encoded. |
SU_RESULT SUImageSetTransform | ( | SUImageRef | image, |
const struct SUTransformation * | transform | ||
) |
Sets the 3-dimensional homogeneous transform of an image object.
[in] | image | The image object. |
[in] | transform | The affine transform to set. |
SU_EXPORT SUDrawingElementRef SUImageToDrawingElement | ( | SUImageRef | image | ) |
Converts from an SUImageRef to an SUDrawingElementRef. This is essentially an upcast operation.
[in] | image | The given image reference. |
SU_EXPORT SUEntityRef SUImageToEntity | ( | SUImageRef | image | ) |
Converts from an SUImageRef to an SUEntityRef. This is essentially an upcast operation.
[in] | image | The given image reference. |