Class Index | File Index

Classes


Class HomeXMLExporter


Extends ObjectXMLExporter.

Defined in: SweetHome3D.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Exporter for home instances.
Method Summary
Method Attributes Method Name and Description
 
getExportedContentName(owner, content)
Returns the saved name of the given content owned by an object.
 
getId(object)
Returns the XML id of the given object that can be referenced by other elements.
 
writeAttributes(writer, home)
Writes as XML attributes some data of home object with the given writer.
 
writeBackgroundImage(writer, backgroundImage)
Writes in XML the background object with the given writer.
 
writeBaseboard(writer, baseboard, attributeName)
Writes in XML the baseboard object with the given writer.
 
writeCamera(writer, camera, attributeName)
Writes in XML the camera object with the given writer.
 
writeChildren(writer, home)
Writes as XML elements some objects that depends on of home with the given writer.
 
writeCompass(writer, compass)
Writes in XML the compass object with the given writer.
 
writeDimensionLine(writer, dimensionLine)
Writes in XML the dimensionLine object with the given writer.
 
writeElement(writer, home)
Writes in XML the home object and the objects that depends on it with the given writer.
 
writeEnvironment(writer, environment)
Writes in XML the environment object with the given writer.
 
writeLabel(writer, label)
Writes in XML the label object with the given writer.
 
writeLevel(writer, level)
Writes in XML the level object with the given writer.
 
writeMaterial(writer, material, model)
Writes in XML the material object with the given writer.
 
writePieceOfFurniture(writer, piece)
Writes in XML the piece object with the given writer.
 
writePolyline(writer, polyline)
Writes in XML the polyline object with the given writer.
 
writePrint(writer, print)
Writes in XML the print object with the given writer.
 
writeRoom(writer, room)
Writes in XML the room object with the given writer.
 
writeTextStyle(writer, textStyle, attributeName)
Writes in XML the textStyle object with the given writer.
 
writeTexture(writer, texture, attributeName)
Writes in XML the texture object with the given writer.
 
writeWall(writer, wall)
Writes in XML the wall object with the given writer.
Methods borrowed from class ObjectXMLExporter:
getTag
Class Detail
HomeXMLExporter()
Exporter for home instances. Homes will be written using the DTD given in HomeXMLHandler class.
Author: Emmanuel Puybaret.
Method Detail
{string} getExportedContentName(owner, content)
Returns the saved name of the given content owned by an object.
Parameters:
{Object} owner
{Object} content
Returns:
{string}

{string} getId(object)
Returns the XML id of the given object that can be referenced by other elements.
Parameters:
{Object} object
Throws:
IllegalArgumentException if the object has no associated id.
Returns:
{string}

writeAttributes(writer, home)
Writes as XML attributes some data of home object with the given writer.
Parameters:
{XMLWriter} writer
{Home} home

writeBackgroundImage(writer, backgroundImage)
Writes in XML the background object with the given writer.
Parameters:
{XMLWriter} writer
{BackgroundImage} backgroundImage

writeBaseboard(writer, baseboard, attributeName)
Writes in XML the baseboard object with the given writer.
Parameters:
{XMLWriter} writer
{Baseboard} baseboard
{string} attributeName

writeCamera(writer, camera, attributeName)
Writes in XML the camera object with the given writer.
Parameters:
{XMLWriter} writer
{Camera} camera
{string} attributeName

writeChildren(writer, home)
Writes as XML elements some objects that depends on of home with the given writer.
Parameters:
{XMLWriter} writer
{Home} home

writeCompass(writer, compass)
Writes in XML the compass object with the given writer.
Parameters:
{XMLWriter} writer
{Compass} compass

writeDimensionLine(writer, dimensionLine)
Writes in XML the dimensionLine object with the given writer.
Parameters:
{XMLWriter} writer
{DimensionLine} dimensionLine

writeElement(writer, home)
Writes in XML the home object and the objects that depends on it with the given writer.
Parameters:
{XMLWriter} writer
{Home} home

writeEnvironment(writer, environment)
Writes in XML the environment object with the given writer.
Parameters:
{XMLWriter} writer
{HomeEnvironment} environment

writeLabel(writer, label)
Writes in XML the label object with the given writer.
Parameters:
{XMLWriter} writer
{Label} label

writeLevel(writer, level)
Writes in XML the level object with the given writer.
Parameters:
{XMLWriter} writer
{Level} level

writeMaterial(writer, material, model)
Writes in XML the material object with the given writer.
Parameters:
{XMLWriter} writer
{HomeMaterial} material
{Object} model

writePieceOfFurniture(writer, piece)
Writes in XML the piece object with the given writer.
Parameters:
{XMLWriter} writer
{HomePieceOfFurniture} piece

writePolyline(writer, polyline)
Writes in XML the polyline object with the given writer.
Parameters:
{XMLWriter} writer
{Polyline} polyline

writePrint(writer, print)
Writes in XML the print object with the given writer.
Parameters:
{XMLWriter} writer
{HomePrint} print

writeRoom(writer, room)
Writes in XML the room object with the given writer.
Parameters:
{XMLWriter} writer
{Room} room

writeTextStyle(writer, textStyle, attributeName)
Writes in XML the textStyle object with the given writer.
Parameters:
{XMLWriter} writer
{TextStyle} textStyle
{string} attributeName

writeTexture(writer, texture, attributeName)
Writes in XML the texture object with the given writer.
Parameters:
{XMLWriter} writer
{HomeTexture} texture
{string} attributeName

writeWall(writer, wall)
Writes in XML the wall object with the given writer.
Parameters:
{XMLWriter} writer
{Wall} wall

© Copyright 2024 Space Mushrooms
Distributed under GNU General Public License
Documentation generated by JsDoc Toolkit 2.4.0 on Wed Aug 21 2024 17:43:24 GMT+0200 (CEST)