public class JAAvatarsEnv
extends java.lang.Object
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ASD_XML_NAME
ASD (Avatar Structure Definition) XML file name.
|
static java.lang.String |
AVATAR_DEF_NAME_ARP
Avatar definition file name with ".arp" suffix.
|
static java.lang.String |
AVATAR_DEF_NAME_JARP
Avatar definition file name with standard ".jarp" suffix.
|
static java.lang.String |
AVATAR_DEF_STEM
Avatar definition file name stem.
|
static int |
AXI_ASD
Avatar XML Index: for avatar's ASD file.
|
static int |
AXI_AVATAR_CONFIG
Avatar XML Index: for avatar's configuration file.
|
static int |
AXI_COMMON_CONFIG
Avatar XML Index: for common configuration file.
|
static int |
AXI_COUNT
Total count of valid Avatar XML Indices.
|
static int |
AXI_NONMANUALS
Avatar XML Index: for avatar's non-manuals file.
|
static java.lang.String |
COMMON_BASE_NAME
Common avatar data base directory name.
|
static java.lang.String |
CONFIG_XML_NAME
Animgen configuration XML file name.
|
static java.lang.String |
NONMANUALS_XML_NAME
Nonmanuals XML file name.
|
Constructor and Description |
---|
JAAvatarsEnv(JAOptions jaopts)
Constructs a new avatars environment based on the given JA options
collection.
|
Modifier and Type | Method and Description |
---|---|
int |
countAvatars()
Returns the number of avatars in this environment's avatar list.
|
java.lang.String |
currentAvatar()
Returns the name of this environment's currently selected avatar.
|
java.lang.String[] |
getAvatars()
Returns this environment's avatar list.
|
AvatarDefinitionAccess |
getDefinition(java.lang.String av) |
byte[][] |
getXMLConfigTexts(java.lang.String av)
Returns the texts of the XML configuration files for the current
avatar, as byte arrays, whose indices are
AXI_COMMON_CONFIG ,
etc. |
boolean |
isValidAvatar(java.lang.String av)
Tests for the presence of the given name in the avatar list and that
avatar can be accessed.
|
void |
setAvatar(java.lang.String av)
Sets the avatar currently selected in this environment to be the
given one, providing it is in the avatar list; otherwise makes
no change.
|
void |
terminate()
Terminates this avatars environment, by terminating each of its
cached data access objects.
|
public static final java.lang.String COMMON_BASE_NAME
public static final java.lang.String CONFIG_XML_NAME
public static final java.lang.String ASD_XML_NAME
public static final java.lang.String NONMANUALS_XML_NAME
public static final java.lang.String AVATAR_DEF_STEM
public static final java.lang.String AVATAR_DEF_NAME_JARP
public static final java.lang.String AVATAR_DEF_NAME_ARP
public static final int AXI_COMMON_CONFIG
public static final int AXI_AVATAR_CONFIG
public static final int AXI_ASD
public static final int AXI_NONMANUALS
public static final int AXI_COUNT
public JAAvatarsEnv(JAOptions jaopts)
public int countAvatars()
public java.lang.String currentAvatar()
public java.lang.String[] getAvatars()
public void setAvatar(java.lang.String av)
public byte[][] getXMLConfigTexts(java.lang.String av)
AXI_COMMON_CONFIG
,
etc. .public boolean isValidAvatar(java.lang.String av)
public void terminate()
public AvatarDefinitionAccess getDefinition(java.lang.String av)