Class Index | File Index

Classes


Class BackgroundImage


Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
BackgroundImage(image, scaleDistance, scaleDistanceXStart, scaleDistanceYStart, scaleDistanceXEnd, scaleDistanceYEnd, xOrigin, yOrigin, visible)
Creates a background image.
Method Summary
Method Attributes Method Name and Description
 
Returns the image content of this background image.
 
Returns the scale of this image.
<static>  
BackgroundImage.getScale(scaleDistance, scaleDistanceXStart, scaleDistanceYStart, scaleDistanceXEnd, scaleDistanceYEnd)
Returns the scale equal to scaleDistance divided by the distance between the points (scaleDistanceXStart, scaleDistanceYStart) and (scaleDistanceXEnd, scaleDistanceYEnd).
 
Returns the distance used to compute the scale of this image.
 
Returns the abscissa of the end point used to compute the scale of this image.
 
Returns the abscissa of the start point used to compute the scale of this image.
 
Returns the ordinate of the end point used to compute the scale of this image.
 
Returns the ordinate of the start point used to compute the scale of this image.
 
Returns the origin abscissa of this image.
 
Returns the origin ordinate of this image.
 
Returns true if this image is visible in plan.
Class Detail
BackgroundImage(image, scaleDistance, scaleDistanceXStart, scaleDistanceYStart, scaleDistanceXEnd, scaleDistanceYEnd, xOrigin, yOrigin, visible)
Creates a background image.
Author: Emmanuel Puybaret.
Parameters:
{Object} image
{number} scaleDistance
{number} scaleDistanceXStart
{number} scaleDistanceYStart
{number} scaleDistanceXEnd
{number} scaleDistanceYEnd
{number} xOrigin
{number} yOrigin
{boolean} visible
Method Detail
{Object} getImage()
Returns the image content of this background image.
Returns:
{Object}

{number} getScale()
Returns the scale of this image.
Returns:
{number}

<static> {number} BackgroundImage.getScale(scaleDistance, scaleDistanceXStart, scaleDistanceYStart, scaleDistanceXEnd, scaleDistanceYEnd)
Returns the scale equal to scaleDistance divided by the distance between the points (scaleDistanceXStart, scaleDistanceYStart) and (scaleDistanceXEnd, scaleDistanceYEnd).
Parameters:
{number} scaleDistance
{number} scaleDistanceXStart
{number} scaleDistanceYStart
{number} scaleDistanceXEnd
{number} scaleDistanceYEnd
Returns:
{number}

{number} getScaleDistance()
Returns the distance used to compute the scale of this image.
Returns:
{number}

{number} getScaleDistanceXEnd()
Returns the abscissa of the end point used to compute the scale of this image.
Returns:
{number}

{number} getScaleDistanceXStart()
Returns the abscissa of the start point used to compute the scale of this image.
Returns:
{number}

{number} getScaleDistanceYEnd()
Returns the ordinate of the end point used to compute the scale of this image.
Returns:
{number}

{number} getScaleDistanceYStart()
Returns the ordinate of the start point used to compute the scale of this image.
Returns:
{number}

{number} getXOrigin()
Returns the origin abscissa of this image.
Returns:
{number}

{number} getYOrigin()
Returns the origin ordinate of this image.
Returns:
{number}

{boolean} isVisible()
Returns true if this image is visible in plan.
Returns:
{boolean}

© Copyrights 2017 Emmanuel PUYBARET / eTeks
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Oct 25 2017 16:36:08 GMT+0200 (CEST)