Package com.solibri.smc.api.visualization

Interface Bitmap

All Superinterfaces:

VisualizationItem<Bitmap>

public interface Bitmap
extends VisualizationItem<Bitmap>

Visualization item for visualizing bitmap.

Since:

9.10.2

Method Summary

Modifier and Type	Method	Description
static Bitmap	create(ARGBColor color, BufferedImage image, Vector3d normal, Vector3d up, Vector3d location, double width, double height)	Creates a bitmap visualization.
static Bitmap	create(BufferedImage image, Vector3d normal, Vector3d up, Vector3d location, double width, double height)	Creates a bitmap visualization.
Vector3d	getCenter()	Returns a point indicating the center position of this bitmap.
double	getHeight()	Returns the height of image.
BufferedImage	getImage()	Returns the image.
Vector3d	getNormal()	Returns a vector indicating where this bitmap faces.
Vector3d	getUp()	Returns a vector indicating the 'up' direction of this bitmap's 2D content.
double	getWidth()	Returns the width of image.

Methods inherited from interface com.solibri.smc.api.visualization.VisualizationItem

getColor, withColor

Method Detail

create

static Bitmap create(ARGBColor color,
                     BufferedImage image,
                     Vector3d normal,
                     Vector3d up,
                     Vector3d location,
                     double width,
                     double height)

Creates a bitmap visualization.

Parameters:

color - color with transparency affecting the displayed image

image - the image to be displayed

normal - a vector indicating where the image faces in 3D space

up - a vector whose orthogonal-to-normal (orthogonal to the facing direction given by normal) component indicates the 'up' direction of the image.

location - the center of the image in 3D space

width - the width of the displayed image

height - the height of the displayed image

Returns:

a bitmap visualization item with the given image. The bitmap's positioning when displayed in 3D view is given by normal, up, location.

Since:

9.10.2

create

static Bitmap create(BufferedImage image,
                     Vector3d normal,
                     Vector3d up,
                     Vector3d location,
                     double width,
                     double height)

Creates a bitmap visualization.

Parameters:

image - the image to be displayed

normal - a vector indicating where the image faces in 3D space

up - a vector whose orthogonal-to-normal (orthogonal to the facing direction given by normal) component indicates the 'up' direction of the image.

location - the center of the image in 3D space

width - the width of the displayed image

height - the height of the displayed image

Returns:

a bitmap visualization item with the given image. The bitmap's positioning when displayed in 3D view is

given by normal, up, location.

Since:

9.10.2

getImage

BufferedImage getImage()

Returns the image.

Returns:

the image

Since:

9.10.2

getHeight

double getHeight()

Returns the height of image.

Returns:

the height of image

Since:

9.10.2

getWidth

double getWidth()

Returns the width of image.

Returns:

the width of image

Since:

9.10.2

getNormal

Vector3d getNormal()

Returns a vector indicating where this bitmap faces. Example: An image is placed on the xy-plane and faces up, towards the positive z-direction. Its normal is (0, 0, 1). This vector is orthogonal to getUp() if they are both non-zero vectors.

Returns:

a unit vector indicating where this bitmap faces or a zero vector

Since:

9.12.0

getUp

Vector3d getUp()

Returns a vector indicating the 'up' direction of this bitmap's 2D content. For example, a letter "T" lying in the xy-plane, facing up towards the positive z-direction with its bottom side parallel to the x-axis, has the y-axis as its 'up' direction. Its 'up' vector is then (0, 1, 0). This vector is orthogonal to getNormal() if they are both non-zero vectors.

Returns:

a unit vector indicating the 'up' direction of this bitmap's 2D content or a zero vector

Since:

9.12.0

getCenter

Vector3d getCenter()

Returns a point indicating the center position of this bitmap.

Returns:

a point indicating the position of this bitmap in 3D space.

Since:

9.12.0