Class BackgroundImageWizardController
				
				
Extends
					WizardController.
				
			
				
				
				
					
Defined in:  SweetHome3D.js.
				
			
| Constructor Attributes | Constructor Name and Description | 
|---|---|
| 
								BackgroundImageWizardController(home, preferences, viewFactory, contentManager, undoSupport)
							 Wizard controller for background image in plan. | 
| Method Attributes | Method Name and Description | 
|---|---|
| finish()
								 Changes background image in model and posts an undoable operation. | |
| Returns the content manager of this controller. | |
| getImage()
								 Returns the image content of the background image. | |
| Returns the image choice step state. | |
| Returns the image origin step state. | |
| Returns the image scale step state. | |
| Returns the background image of another level that can be used to initialize
the scale values of the edited image. | |
| Returns the scale distance of the background image. | |
| Returns the coordinates of the scale distance points of the background image. | |
| getStep()
								 Returns the current step in wizard view. | |
| Returns the current step state. | |
| Returns the unique wizard view used for all steps. | |
| Returns the abscissa of the origin of the background image. | |
| Returns the ordinate of the origin of the background image. | |
| setImage(image)
								 Sets the image content of the background image. | |
| setOrigin(xOrigin, yOrigin)
								 Sets the origin of the background image. | |
| setScaleDistance(scaleDistance)
								 Sets the scale distance of the background image. | |
| setScaleDistancePoints(scaleDistanceXStart, scaleDistanceYStart, scaleDistanceXEnd, scaleDistanceYEnd)
								 Sets the coordinates of the scale distance points of the background image. | |
| setStep(step)
								 Switch in the wizard view to the given  step. | 
- Methods borrowed from class WizardController:
- addPropertyChangeListener, displayView, getStepIcon, getStepView, getTitle, getView, goBackToPreviousStep, goToNextStep, isBackStepEnabled, isLastStep, isNextStepEnabled, isResizable, removePropertyChangeListener, setResizable, setStepState, setTitle
					Class Detail
				
				
				
						BackgroundImageWizardController(home, preferences, viewFactory, contentManager, undoSupport)
				
				
				
					Wizard controller for background image in plan.
					
Author: Emmanuel Puybaret.
				
				
				
				
					
						Author: Emmanuel Puybaret.
- Parameters:
- {Home} home
- {UserPreferences} preferences
- {Object} viewFactory
- {Object} contentManager
- {javax.swing.undo.UndoableEditSupport} undoSupport
					Method Detail
				
				
					 
					
					
					
					finish()
					
					
					
						Changes background image in model and posts an undoable operation.
						
						
					
					
					
					
						
						
						
						
						
						
						
					
					
					{Object}
					getContentManager()
					
					
					
						Returns the content manager of this controller.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {Object}
					
					{Object}
					getImage()
					
					
					
						Returns the image content of the background image.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {Object}
					
					{BackgroundImageWizardController.BackgroundImageWizardStepState}
					getImageChoiceStepState()
					
					
					
						Returns the image choice step state.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {BackgroundImageWizardController.BackgroundImageWizardStepState}
					
					{BackgroundImageWizardController.BackgroundImageWizardStepState}
					getImageOriginStepState()
					
					
					
						Returns the image origin step state.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {BackgroundImageWizardController.BackgroundImageWizardStepState}
					
					{BackgroundImageWizardController.BackgroundImageWizardStepState}
					getImageScaleStepState()
					
					
					
						Returns the image scale step state.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {BackgroundImageWizardController.BackgroundImageWizardStepState}
					
					{BackgroundImage}
					getReferenceBackgroundImage()
					
					
					
						Returns the background image of another level that can be used to initialize
the scale values of the edited image.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {BackgroundImage}
					
					{number}
					getScaleDistance()
					
					
					
						Returns the scale distance of the background image.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {number}
					
					{float[][]}
					getScaleDistancePoints()
					
					
					
						Returns the coordinates of the scale distance points of the background image.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {float[][]}
					
					{BackgroundImageWizardController.Step}
					getStep()
					
					
					
						Returns the current step in wizard view.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {BackgroundImageWizardController.Step}
					
					{BackgroundImageWizardController.BackgroundImageWizardStepState}
					getStepState()
					
					
					
						Returns the current step state.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {BackgroundImageWizardController.BackgroundImageWizardStepState}
					
					{Object}
					getStepsView()
					
					
					
						Returns the unique wizard view used for all steps.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {Object}
					
					{number}
					getXOrigin()
					
					
					
						Returns the abscissa of the origin of the background image.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {number}
					
					{number}
					getYOrigin()
					
					
					
						Returns the ordinate of the origin of the background image.
						
						
					
					
					
					
						
						
						
						
						
							- Returns:
- {number}
					
					
					setImage(image)
					
					
					
						Sets the image content of the background image.
						
						
					
					
					
					
						
							- Parameters:
- {Object} image
					
					
					setOrigin(xOrigin, yOrigin)
					
					
					
						Sets the origin of the background image.
						
						
					
					
					
					
						
							- Parameters:
- {number} xOrigin
- {number} yOrigin
					
					
					setScaleDistance(scaleDistance)
					
					
					
						Sets the scale distance of the background image.
						
						
					
					
					
					
						
							- Parameters:
- {number} scaleDistance
					
					
					setScaleDistancePoints(scaleDistanceXStart, scaleDistanceYStart, scaleDistanceXEnd, scaleDistanceYEnd)
					
					
					
						Sets the coordinates of the scale distance points of the background image.
						
						
					
					
					
					
						
							- Parameters:
- {number} scaleDistanceXStart
- {number} scaleDistanceYStart
- {number} scaleDistanceXEnd
- {number} scaleDistanceYEnd
					
					
					setStep(step)
					
					
					
						Switch in the wizard view to the given 
					
					
					
						
							step.
						
						
					- Parameters:
- {BackgroundImageWizardController.Step} step

