com.openinventor.inventor.actions

Class SoToHTMLAction

java.lang.Object

com.openinventor.inventor.Inventor

com.openinventor.inventor.actions.SoAction

com.openinventor.inventor.actions.SoToHTMLAction

public class SoToHTMLAction
extends SoAction

Generates an HTML image map and an image from a scene graph. This action generates an image file and an HTML file containing the image (<IMG>) and image map (<MAP>) tags. Each region of the image map will have a URL associated with it.

With HTML, image maps allow to specify regions of an image and assign a specific action to each region (a link can be associated to each map). When the region is activated by the user, the action is executed.

Each region of the image is determined by a subgraph which is under an SoWWWAnchor or SoVRMLAnchor group node.

The HTML file generated contains, in the following order:

1. An image map tag that defines the regions (maps) corresponding to each subgraph that is under an SoWWWAnchor or SoVRMLAnchor group node.
   For each region, the associated link is the URL defined either by the SoWWWAnchor or SoVRMLAnchor node.
2. An image tag that references the image generated by SoToHTMLAction.

See also:

SoAction

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SoToHTMLAction.Components Components used to generate the image.
static class	SoToHTMLAction.ImageFormats Defines the format of the image.
static class	SoToHTMLAction.ShapeTypes Defines the different shape type for maps.

Nested classes/interfaces inherited from class com.openinventor.inventor.actions.SoAction

SoAction.AppliedCodes, SoAction.DistribModes, SoAction.PathCodes, SoAction.PathIndices

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Inventor.ConstructorCommand

Field Summary

Fields

Modifier and Type	Field and Description
static int	BMP_FORMAT Deprecated. Use SoToHTMLAction.ImageFormats.BMP_FORMAT instead.
static int	CIRCLE Deprecated. Use SoToHTMLAction.ShapeTypes.CIRCLE instead.
static int	JPEG_FORMAT Deprecated. Use SoToHTMLAction.ImageFormats.JPEG_FORMAT instead.
static int	LUMINANCE Deprecated. Use SoToHTMLAction.Components.LUMINANCE instead.
static int	LUMINANCE_TRANSPARENCY Deprecated. Use SoToHTMLAction.Components.LUMINANCE_TRANSPARENCY instead.
static int	NONE Deprecated. Use SoToHTMLAction.ShapeTypes.NONE instead.
static int	POLYGON Deprecated. Use SoToHTMLAction.ShapeTypes.POLYGON instead.
static int	RECTANGLE Deprecated. Use SoToHTMLAction.ShapeTypes.RECTANGLE instead.
static int	RGB Deprecated. Use SoToHTMLAction.Components.RGB instead.
static int	RGB_TRANSPARENCY Deprecated. Use SoToHTMLAction.Components.RGB_TRANSPARENCY instead.

Fields inherited from class com.openinventor.inventor.actions.SoAction

ALL, BELOW_PATH, CLUSTER_ONLY, IN_PATH, LOCAL_ONLY, NO_PATH, NODE, OFF_PATH, PATH, PATH_LIST

Fields inherited from class com.openinventor.inventor.Inventor

VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors

Constructor and Description
SoToHTMLAction() Constructor.

Method Summary

Modifier and Type	Method and Description
void	closeHTMLFile() Closes the HTML output file.
static void	enableElement(java.lang.Class<? extends Inventor> t, int stkIndex)
SbColor	getImageBackgroundColor() Returns the image background color.
SoToHTMLAction.Components	getImageComponents() Returns the components of image.
SoToHTMLAction.ImageFormats	getImageFormat() Returns the image format.
float	getImageQuality() Returns the image quality.
java.lang.String	getImageURLName() Returns the URL name of image in the HTML file.
SoToHTMLAction.ShapeTypes	getRegionShapeType() Returns the region shape type.
SbViewportRegion	getViewportRegion() Returns viewport region for the image.
boolean	isMapHighlight() Returns anchor highlighting.
boolean	openHTMLFile(java.lang.String filename) Opens named file.
void	resetHTMLBuffer() Resets buffer of the HTML output for output again.
void	setImageBackgroundColor(SbColor c) Sets the image background color.
void	setImageComponents(SoToHTMLAction.Components components) Sets the components of image.
void	setImageFormat(SoToHTMLAction.ImageFormats format) Sets the image format.
void	setImageQuality(float quality) Sets the image quality.
void	setImageURLName(java.lang.String name) Sets the URL name of image in the HTML file, ("image.jpg" by default).
void	setMapHighlight(boolean onOff) Sets anchor highlighting.
void	setRegionShapeType(SoToHTMLAction.ShapeTypes type) Sets the region shape type.
void	setViewportRegion(SbViewportRegion region) Specifies viewport region for the image.

Methods inherited from class com.openinventor.inventor.actions.SoAction

apply, apply, clearApplyResult, forwardTraversal, getContinueActionInBranchFlag, getCurPath, getNodeAppliedTo, getOriginalPathListAppliedTo, getPathAppliedTo, getPathCode, getPathListAppliedTo, getPipeId, getSceneManager, getState, getWhatAppliedTo, hasTerminated, invalidateState, isBeingApplied, isLastPathListAppliedTo, isUsingAlternateRep, nullAction, postDelayedTraversal, preDelayedTraversal, resetContinueActionInBranchFlag, setPipeId, setSceneManager, setUpState, stopActionInBranch, traverse, useAlternateRep

Methods inherited from class com.openinventor.inventor.Inventor

dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object

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

Field Detail

NONE

@Deprecated
public static final int NONE

Deprecated. Use SoToHTMLAction.ShapeTypes.NONE instead.

RECTANGLE

@Deprecated
public static final int RECTANGLE

Deprecated. Use SoToHTMLAction.ShapeTypes.RECTANGLE instead.

CIRCLE

@Deprecated
public static final int CIRCLE

Deprecated. Use SoToHTMLAction.ShapeTypes.CIRCLE instead.

POLYGON

@Deprecated
public static final int POLYGON

Deprecated. Use SoToHTMLAction.ShapeTypes.POLYGON instead.

LUMINANCE

@Deprecated
public static final int LUMINANCE

Deprecated. Use SoToHTMLAction.Components.LUMINANCE instead.

LUMINANCE_TRANSPARENCY

@Deprecated
public static final int LUMINANCE_TRANSPARENCY

Deprecated. Use SoToHTMLAction.Components.LUMINANCE_TRANSPARENCY instead.

RGB

@Deprecated
public static final int RGB

Deprecated. Use SoToHTMLAction.Components.RGB instead.

RGB_TRANSPARENCY

@Deprecated
public static final int RGB_TRANSPARENCY

Deprecated. Use SoToHTMLAction.Components.RGB_TRANSPARENCY instead.

BMP_FORMAT

@Deprecated
public static final int BMP_FORMAT

Deprecated. Use SoToHTMLAction.ImageFormats.BMP_FORMAT instead.

JPEG_FORMAT

@Deprecated
public static final int JPEG_FORMAT

Deprecated. Use SoToHTMLAction.ImageFormats.JPEG_FORMAT instead.

Constructor Detail

SoToHTMLAction

public SoToHTMLAction()

Constructor.

Method Detail

openHTMLFile

public boolean openHTMLFile(java.lang.String filename)

Opens named file. This returns false on error. By default, output goes to stdout .

closeHTMLFile

public void closeHTMLFile()

Closes the HTML output file.

setImageQuality

public void setImageQuality(float quality)

Sets the image quality. Used for JPEG image. Quality is a value from 0. to 1., with 0 being the worst quality (maximum compression) and 1 being the best quality (minimum compression). The default is 1.

getImageBackgroundColor

public SbColor getImageBackgroundColor()

Returns the image background color.

setImageFormat

public void setImageFormat(SoToHTMLAction.ImageFormats format)

Sets the image format. JPEG_FORMAT by default.

setImageComponents

public void setImageComponents(SoToHTMLAction.Components components)

Sets the components of image. RGB by default.

getImageComponents

public SoToHTMLAction.Components getImageComponents()

Returns the components of image.

getImageFormat

public SoToHTMLAction.ImageFormats getImageFormat()

Returns the image format.

setMapHighlight

public void setMapHighlight(boolean onOff)

Sets anchor highlighting. true by default.

getRegionShapeType

public SoToHTMLAction.ShapeTypes getRegionShapeType()

Returns the region shape type.

getViewportRegion

public SbViewportRegion getViewportRegion()

Returns viewport region for the image.

setRegionShapeType

public void setRegionShapeType(SoToHTMLAction.ShapeTypes type)

Sets the region shape type. POLYGON by default.

enableElement

public static void enableElement(java.lang.Class<? extends Inventor> t,
                                 int stkIndex)

isMapHighlight

public boolean isMapHighlight()

Returns anchor highlighting.

setImageBackgroundColor

public void setImageBackgroundColor(SbColor c)

Sets the image background color. SbColor(0,0,0) by default.

resetHTMLBuffer

public void resetHTMLBuffer()

Resets buffer of the HTML output for output again. Output starts over at beginning of buffer.

getImageQuality

public float getImageQuality()

Returns the image quality.

getImageURLName

public java.lang.String getImageURLName()

Returns the URL name of image in the HTML file.

setViewportRegion

public void setViewportRegion(SbViewportRegion region)

Specifies viewport region for the image. Allows the user to specify the image size.

setImageURLName

public void setImageURLName(java.lang.String name)

Sets the URL name of image in the HTML file, ("image.jpg" by default). This is the first way to specify the image file name.