Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Properties

ISkpImage Interface Reference

An image. More...

Inheritance diagram for ISkpImage:
SkpImage

List of all members.

Properties

ISkpTransform Transform [get]
 [propget] The transform from the associated component definition to model space.
BSTR Path [get]
 [propget] The path to the file from whence this image was derived.
double Width [get]
 [propget] Returns the width of the image in the model.
double Height [get]
 [propget] Returns the height of the image in the model.
long PixelWidth [get]
 [propget] Returns the width of the image in the model.
long PixelHeight [get]
 [propget] Returns the height of the image in the model.
double ZRotation [get]
 [propget] Returns the rotation about the image's z-axis (or normal).
ISkpPoint3d Origin [get]
 [propget] Returns the origin of the image.
ISkpVector3d Normal [get]
 [propget] Returns the normal vector of the image.
BSTR Name [get]
 [propget] Returns the name of the image.

Detailed Description

An image.


Property Documentation

double ISkpImage::Height [get]

[propget] Returns the height of the image in the model.

The units are inches.

Return values:
pVal The height of the image in the model.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpImage::Name [get]

[propget] Returns the name of the image.

Return values:
pVal The images's name.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpVector3d ISkpImage::Normal [get]

[propget] Returns the normal vector of the image.

Return values:
pVal The image's normal vector.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpImage::Origin [get]

[propget] Returns the origin of the image.

Return values:
pVal The image's origin in world coordinates.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpImage::Path [get]

[propget] The path to the file from whence this image was derived.

Return values:
pVal The file path.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
long ISkpImage::PixelHeight [get]

[propget] Returns the height of the image in the model.

The units are in pixels.

Return values:
pVal The height of the image in the model.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
long ISkpImage::PixelWidth [get]

[propget] Returns the width of the image in the model.

The units are in pixels.

Return values:
pVal The width of the image in the model.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpTransform ISkpImage::Transform [get]

[propget] The transform from the associated component definition to model space.

Return values:
pVal The associated transformation.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpImage::Width [get]

[propget] Returns the width of the image in the model.

The units are inches.

Return values:
pVal The width of the image in the model.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
double ISkpImage::ZRotation [get]

[propget] Returns the rotation about the image's z-axis (or normal).

The units are in radians.

Return values:
pVal The rotation about the image's z-axis (or normal).
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

©2010 Google - Google Home - About Google