com.mathworks.toolbox.javabuilder.webfigures

Class WebFigureRenderParameters

java.lang.Object

com.mathworks.toolbox.javabuilder.webfigures.WebFigureRenderParameters

public class WebFigureRenderParameters
extends java.lang.Object

Parameters for rendering a WebFigure.

See Also:

WebFigureRenderer

Constructor Summary

Constructors

Constructor and Description
WebFigureRenderParameters(WebFigure webFigure) Initialize render parameters from the defaults of the given WebFigure.
WebFigureRenderParameters(WebFigureRenderParameters that) Initialize render parameters by copying all parameters from that.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getCropBottom()
int	getCropLeft()
int	getCropRight()
int	getCropTop()
double	getElevation()
int	getHeight()
java.lang.String	getImageFormat()
double	getRotation()
WebFigure	getWebFigure()
int	getWidth()
int	hashCode()
void	setCropBottom(int cropBottom) Set the number of pixels to crop from the bottom of the render image.
void	setCropLeft(int cropLeft) Set the number of pixels to crop from the left side of the render image.
void	setCropRight(int cropRight) Set the number of pixels to crop from the right side of the render image.
void	setCropTop(int cropTop) Set the number of pixels to crop from the top of the render image.
void	setElevation(double elevation) Set the camera elevation
void	setHeight(int height) Set the uncropped rendered image height
void	setImageFormat(java.lang.String imageFormat) Set the image encoding to use, if calling renderEncoded.
void	setRotation(double rotation) Set the camera azimuth.
void	setWebFigure(WebFigure webFigure) Set the WebFigure to render.
void	setWidth(int width) Set the uncropped rendered image width
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebFigureRenderParameters

public WebFigureRenderParameters(WebFigure webFigure)

Initialize render parameters from the defaults of the given WebFigure.

Parameters:

webFigure - the figure to render

WebFigureRenderParameters

public WebFigureRenderParameters(WebFigureRenderParameters that)

Initialize render parameters by copying all parameters from that.

Parameters:

that - the render parameters to copy

Method Detail

getWebFigure

public WebFigure getWebFigure()

Returns:

the WebFigure to render

getRotation

public double getRotation()

Returns:

the camera azimuth, in degrees

getElevation

public double getElevation()

Returns:

the camera elevation, in degrees

getWidth

public int getWidth()

Returns:

the uncropped rendered image width, in pixels

getHeight

public int getHeight()

Returns:

the uncropped rendered image height, in pixels

getImageFormat

public java.lang.String getImageFormat()

Returns:

the image encoding to use (if calling renderEncoded); one of "png", "jpeg", "gif", etc.

getCropLeft

public int getCropLeft()

Returns:

the number of pixels to crop from the left side of the rendered image

getCropRight

public int getCropRight()

Returns:

the number of pixels to crop from the right side of the rendered image

getCropTop

public int getCropTop()

Returns:

the number of pixels to crop from the top of the rendered image

getCropBottom

public int getCropBottom()

Returns:

the number of pixels to crop from the bottom of the rendered image

setWebFigure

public void setWebFigure(WebFigure webFigure)

Set the WebFigure to render.

Parameters:

webFigure - the WebFigure to render

setRotation

public void setRotation(double rotation)

Set the camera azimuth.

Parameters:

rotation - the camera azimuth, in degrees

setElevation

public void setElevation(double elevation)

Set the camera elevation

Parameters:

elevation - the camera elevation, in degrees

setWidth

public void setWidth(int width)

Set the uncropped rendered image width

Parameters:

width - the uncropped width, in pixels

setHeight

public void setHeight(int height)

Set the uncropped rendered image height

Parameters:

height - the uncropped height, in pixels

setImageFormat

public void setImageFormat(java.lang.String imageFormat)

Set the image encoding to use, if calling renderEncoded.

Parameters:

imageFormat - any image format accepted by javax.imageio.ImageIO.write

setCropLeft

public void setCropLeft(int cropLeft)

Set the number of pixels to crop from the left side of the render image.

Parameters:

cropLeft - number of pixels to crop

setCropRight

public void setCropRight(int cropRight)

Set the number of pixels to crop from the right side of the render image.

Parameters:

cropRight - number of pixels to crop

setCropTop

public void setCropTop(int cropTop)

Set the number of pixels to crop from the top of the render image.

Parameters:

cropTop - number of pixels to crop

setCropBottom

public void setCropBottom(int cropBottom)

Set the number of pixels to crop from the bottom of the render image.

Parameters:

cropBottom - number of pixels to crop

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object