com.eteks.sweethome3d

Class SweetHome3D

java.lang.Object

com.eteks.sweethome3d.model.HomeApplication

com.eteks.sweethome3d.SweetHome3D

public class SweetHome3D
extends HomeApplication

Sweet Home 3D main class. Sweet Home 3D accepts the parameter -open followed by the path of a Sweet Home 3D file.
Users may also define the optional following System properties to alter program behavior:

• com.eteks.sweethome3d.applicationFolders defines the folder(s) where private files of Sweet Home 3D are stored. Private files include SH3F furniture library files stored in a subfolder named furniture, SH3T textures library files stored in a subfolder named textures, SH3L language library files stored in a subfolder named languages, SH3P application plug-in files stored in a subfolder named plugins and SH3D files automatically created for recovery purpose stored in a subfolder named recovery.
  If this property describes more than one folder, they should be separated by a semicolon (;) under Windows or by a colon (:) under Mac OS X and Unix systems. The first folder listed in this property is used as the folder where will be stored recovered SH3D files and SH3F, SH3T, SH3L, SH3P files imported by the user. Thus the user should have write access rights on this first folder otherwise he won't be able to import SH3F, SH3T, SH3L or SH3P files, and auto recovered SH3D files won't be managed. If this folder or one of its furniture, textures, languages, plugins, recovery subfolders don't exist, Sweet Home 3D will create it when needed.
  The other folders are used as resources where SH3F, SH3T, SH3L, SH3P files will be searched in their respective furniture, textures, languages, plugins subfolders. Any of the cited folders may be an absolute path or a relative path to the folder from which the program was launched.
• com.eteks.sweethome3d.preferencesFolder defines the folder where preferences files (preferences.xml and the files depending on it) are stored. The user should have write access rights on this folder otherwise the program won't be able to save his preferences and the files he imported in furniture and textures catalogs. This folder may be the same as the folder cited in com.eteks.sweethome3d.applicationFolders property.
• com.eteks.sweethome3d.singleInstance can be set to false to prevent Sweet Home 3D from running as a single instance under operating systems different from Mac OS X. By default, it will try to run as a single instance when possible.
• com.eteks.sweethome3d.checkUpdates should be set to false if application and library updates shouldn't be checked in Sweet Home 3D.
• com.eteks.sweethome3d.resolutionScale can be set to a decimal value different from 1 to enlarge or reduce user interface elements with a given factor. For example, 1.2 will make them look 20% larger.
• com.eteks.sweethome3d.CSVEncoding can be set to change the default UTF-8 encoding used to export furniture list to CVS text files.
• com.eteks.sweethome3d.no3D should be set to true if 3D capabilities (including 3D view and importing furniture 3D models) shouldn't be used in Sweet Home 3D.
• com.eteks.sweethome3d.j3d.checkOffScreenSupport should be set to false when editing preferences, printing, creating a photo or creating a video always lead to a crash of Sweet Home 3D. This means offscreen 3D images isn't supported by your video driver and Sweet Home 3D doesn't even succeed to test this support. Setting this System property to false disables this test.
• com.eteks.sweethome3d.j3d.useOffScreen3DView can be set to true to force Sweet Home 3D to use offscreen view for its 3D view and other 3D panels displayed at screen.
• com.eteks.sweethome3d.j3d.additionalLoaderClasses defines additional Java 3D loader classes that Sweet Home 3D will use to read 3D models content at formats not supported by default in Sweet Home 3D.
  The classes cited in this property must be available in the classpath and if more than one class is cited, they should be separated by a colon or a space.

The value of a System property can be set with the -D java option.

Author:

Emmanuel Puybaret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SweetHome3D() Creates a home application instance.

Method Summary

Modifier and Type	Method and Description
protected HomeFrameController	createHomeFrameController(Home home) Returns a new instance of a home frame controller after home was created.
protected ContentManager	getContentManager() Returns a content manager able to handle files.
HomeRecorder	getHomeRecorder() Returns a recorder able to write and read homes in files.
HomeRecorder	getHomeRecorder(HomeRecorder.Type type) Returns a recorder of a given type able to write and read homes.
java.lang.String	getId() Returns Sweet Home 3D application read from resources.
java.lang.String	getName() Returns the name of this application read from resources.
protected PluginManager	getPluginManager() Returns the plugin manager of this application.
UserPreferences	getUserPreferences() Returns user preferences stored in resources and local file system.
java.lang.String	getVersion() Returns information about the version of this application.
protected ViewFactory	getViewFactory() Returns a Swing view factory.
protected void	init(java.lang.String[] args) Inits application instance.
static void	main(java.lang.String[] args) Sweet Home 3D entry point.
protected void	start(java.lang.String[] args) Starts application once initialized and opens home passed in arguments.

Methods inherited from class com.eteks.sweethome3d.model.HomeApplication

addHome, addHomesListener, createHome, deleteHome, getHomes, removeHomesListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SweetHome3D

protected SweetHome3D()

Creates a home application instance. Recorders, user preferences, content manager, view factory and plug-in manager handled by this application are lazily instantiated to let subclasses override their creation.

Method Detail

getHomeRecorder

public HomeRecorder getHomeRecorder()

Returns a recorder able to write and read homes in files.

Specified by:

getHomeRecorder in class HomeApplication

getHomeRecorder

public HomeRecorder getHomeRecorder(HomeRecorder.Type type)

Description copied from class: HomeApplication

Returns a recorder of a given type able to write and read homes. Subclasses may override this method to return a recorder matching type.

Overrides:

getHomeRecorder in class HomeApplication

Parameters:

type - a hint for the application to choose the returned recorder.

Returns:

the default recorder able to write and read homes.

getUserPreferences

public UserPreferences getUserPreferences()

Returns user preferences stored in resources and local file system.

Specified by:

getUserPreferences in class HomeApplication

getContentManager

protected ContentManager getContentManager()

Returns a content manager able to handle files.

getViewFactory

protected ViewFactory getViewFactory()

Returns a Swing view factory.

getPluginManager

protected PluginManager getPluginManager()

Returns the plugin manager of this application.

getId

public java.lang.String getId()

Returns Sweet Home 3D application read from resources.

Overrides:

getId in class HomeApplication

getName

public java.lang.String getName()

Returns the name of this application read from resources.

Overrides:

getName in class HomeApplication

getVersion

public java.lang.String getVersion()

Returns information about the version of this application.

Overrides:

getVersion in class HomeApplication

main

public static void main(java.lang.String[] args)

Sweet Home 3D entry point.

Parameters:

args - may contain one .sh3d, .sh3x, .sh3f, .sh3t, .sh3l or .sh3p file to open or install, following a -open option.

init

protected void init(java.lang.String[] args)

Inits application instance.

createHomeFrameController

protected HomeFrameController createHomeFrameController(Home home)

Returns a new instance of a home frame controller after home was created.

start

protected void start(java.lang.String[] args)

Starts application once initialized and opens home passed in arguments. This method is executed from Event Dispatch Thread.