vrdImage

class vrdImage

(Inherits vrdSceneObject)

Class that gives access to VRED’s internal image format.

Functions

vrdImage.getAbsolutePath()

Returns the absolute path of the image.

This returns the absolute path of the image including the file name.

Returns:The absolute path.
Return type:string
vrdImage.getDimension()

Gets the dimension of the image.

This will return width and height of the image as a QSize object.

Returns:The dimension.
Return type:QSize
vrdImage.getHeight()

Gets the height of the image.

Returns:The height in pixel.
Return type:integer
vrdImage.getInline()

Gets if the image is inlined.

Returns:True if the image is inlined, False otherwise.
Return type:bool
vrdImage.getInternal()

Some images are managed internally e.g. by the media editor.

Returns:True, if the image is managed internally
Return type:bool
vrdImage.getPreview(size=96)

Returns an image preview.

Parameters:size (integer) – The maximum horizontal or vertical resolution
Returns:The preview image as a QImage.
Return type:QImage
vrdImage.getWidth()

Gets the width of the image.

Returns:The width in pixel.
Return type:integer
vrdImage.hasAlphaChannel()

Determines if the image has an alpha channel.

Returns:True if the image has an alpha channel, False otherwise.
Return type:bool
vrdImage.hasEnvironmentMapLayout()

Returns if this image can be used as an environment map.

Returns:True if image layout matches.
Return type:bool
vrdImage.setInline(value)

Sets if the image will be inlined or not.

When set to true, the image will keep its whole data when saved e.g. within a project file. Otherwise only a file path string to the reference file is stored. Requirement for latter is that the path is valid and the file exists.

Parameters:value (bool) – True if the image should store its whole data, False otherwise.
vrdImage.toQIcon()

Returns the image data as a QIcon.

Returns:The image as a QIcon.
Return type:QIcon
vrdImage.toQImage()

Returns the image data as a QImage.

Returns:The image as a QImage.
Return type:QImage