Package com.comsol.model

Interface EnvmapManager

All Superinterfaces:

ModelEntity, PrimitiveModelEntity

public interface EnvmapManager
extends ModelEntity

Environment map manager.

Method Summary

Modifier and Type	Method	Description
java.lang.String	createAnalytic(java.lang.String name, boolean createOnClient, int[] groundNadirColor, int[] groundHorizonColor, int[] skyHorizonColor, int[] skyZenithColor)	Create a local environment map from 4 colors.
java.lang.String	createCubeMap(java.lang.String name, boolean createOnClient, java.lang.String clientPathPosXImage, java.lang.String clientPathNegXImage, java.lang.String clientPathPosYImage, java.lang.String clientPathNegYImage, java.lang.String clientPathPosZImage, java.lang.String clientPathNegZImage)	Create a local environment map from 6 cube map images.
java.lang.String	createEquirectangular(java.lang.String name, boolean createOnClient, java.lang.String clientPathEquirectangularImage)	Create a local environment map from an equirectangular image.
void	delete(java.lang.String tag)	Delete an environment map stored locally or in the model.
java.lang.String	exportToLocal(java.lang.String tag, java.lang.String exportedName, boolean createOnClient)	Export an environment map imported to the model to a local directory.
java.lang.String	importToModel(java.lang.String tag, java.lang.String importedName)	Import a local environment map to the model.

Methods inherited from interface com.comsol.model.ModelEntity

active, author, author, comments, comments, dateCreated, dateModified, docMarker, docMarker, help, help, icon, isactive, isActive, label, label, lastModifiedBy, model, model, name, name, resetAuthor, scope, tag, tag, timeCreated, timeModified, version, version

Methods inherited from interface com.comsol.model.PrimitiveModelEntity

getContainer, getDisplayString, resolveModelPath

Method Detail

createAnalytic

java.lang.String createAnalytic(java.lang.String name,
                                boolean createOnClient,
                                int[] groundNadirColor,
                                int[] groundHorizonColor,
                                int[] skyHorizonColor,
                                int[] skyZenithColor)

Create a local environment map from 4 colors.

Parameters:

name - Environment map name.

createOnClient - Whether the environment map to be created should be created on the client or on the server.

groundNadirColor - Ground nadir color (array with red, green and blue channels, each in the 0-255 range).

groundHorizonColor - Ground horizon color (array with red, green and blue channels, each in the 0-255 range).

skyHorizonColor - Sky horizon color (array with red, green and blue channels, each in the 0-255 range).

skyZenithColor - Sky zenith color (array with red, green and blue channels, each in the 0-255 range).

Returns:

Tag of the locally created environment map or null.

createCubeMap

java.lang.String createCubeMap(java.lang.String name,
                               boolean createOnClient,
                               java.lang.String clientPathPosXImage,
                               java.lang.String clientPathNegXImage,
                               java.lang.String clientPathPosYImage,
                               java.lang.String clientPathNegYImage,
                               java.lang.String clientPathPosZImage,
                               java.lang.String clientPathNegZImage)

Create a local environment map from 6 cube map images.

Parameters:

name - Environment map name.

createOnClient - Whether the environment map to be created should be created on the client or on the server.

clientPathPosXImage - Client path to the positive X cube map input image.

clientPathNegXImage - Client path to the negative X cube map input image.

clientPathPosYImage - Client path to the positive Y cube map input image.

clientPathNegYImage - Client path to the negative Y cube map input image.

clientPathPosZImage - Client path to the positive Z cube map input image.

clientPathNegZImage - Client path to the negative Z cube map input image.

Returns:

Tag of the locally created environment map or null.

createEquirectangular

java.lang.String createEquirectangular(java.lang.String name,
                                       boolean createOnClient,
                                       java.lang.String clientPathEquirectangularImage)

Create a local environment map from an equirectangular image.

Parameters:

name - Environment map name.

createOnClient - Whether the environment map to be created should be created on the client or on the server.

clientPathEquirectangularImage - Client path to the equirectangular input image.

Returns:

Tag of the locally created environment map or null.

delete

void delete(java.lang.String tag)

Delete an environment map stored locally or in the model.

Parameters:

tag - Environment map tag of environment map stored locally or in the model.

exportToLocal

java.lang.String exportToLocal(java.lang.String tag,
                               java.lang.String exportedName,
                               boolean createOnClient)

Export an environment map imported to the model to a local directory.

Parameters:

tag - Environment map tag of environment map stored in the model.

exportedName - Name of exported environment map.

createOnClient - Whether the exported environment map should be created on the client or on the server.

Returns:

Tag of the local (exported) environment map or null.

importToModel

java.lang.String importToModel(java.lang.String tag,
                               java.lang.String importedName)

Import a local environment map to the model.

Parameters:

tag - Environment map tag of environment map stored locally.

importedName - Name of imported environment map.

Returns:

Tag of the environment map imported to the model or null.