DirectX Media for Animation Java Reference

Previous

Classes

Index

Next

StringBvr Class

public class StringBvr extends Behavior {
    // Methods
    public String extract() throws IllegalExtract;
    
    public static StringBvr concat(StringBvr a, StringBvr b);
    public static StringBvr newUninitBvr();
    public static StringBvr toBvr(String string);

         
    }

Creates an object that represents a string behavior. At any given time, the value of the behavior is a character string.

For more information about behaviors, see the Behavior class.

Methods

extract

public String    extract() throws IllegalExtract;

Extracts the value of the string behavior. This behavior must have a constant value.

Return Value:

Returns a Java character string.

Throws:

IllegalExtract Attempt to call on a non-constant StringBvr object, such as created by the until method.

concat

public static StringBvr concat(StringBvr a, StringBvr b);

Creates a string behavior representing the concatenation of the given behaviors. The behavior's value is the character string consisting of the value of b appended to the end of the value of a.

Return Value:

Returns the StringBvr object.

Parameter	Description
a and b	The StringBvr objects to concatenate.

newUninitBvr

public static StringBvr newUninitBvr();

Allows you to refer to an StringBvr behavior before that behavior has been defined. With this method you can create the behavior and use it in the definition of other behaviors, but not actually define its contents until some later point. (This is accomplished with the init method, which is available on all behaviors.) The system generates a run-time error if you initialize a non-uninitialized behavior, initialize an uninitialized behavior that has already been initialized, or run an initialized behavior that has not yet been initialized.

Return Value:

Returns the StringBvr object.

Parameter	Description
b	A character string.

toBvr

public static StringBvr toBvr(String string);

Converts a type of Java.lang.String to a StringBvr. The only time toBvr is used is when converting Java numbers, booleans, or strings to their corresponding Direct Animation types. It is not used for constants such as red, yVector3, and origin2 because these are defined as constant behaviors.

Return Value:

Returns the StringBvr object;

Parameter	Description
string	The String type to be converted.