|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.cult3d.world.Property
This class provides a representation of a property in
a node, sound, or event.
Use the methods getEventProperty, getNodeProperty and getSoundProperty
to get an instance of this class.
Field Summary | |
static int |
BOOLEAN
|
static int |
CURRENT
|
static int |
FLOAT
|
static int |
INITIAL
|
static int |
INTEGER
|
static int |
MATRIX
|
static int |
ORIENTATION
|
static int |
PREVIOUS
|
static int |
STRING
|
static int |
UNKNOWN
|
static int |
VECTOR3D
|
Method Summary | |
boolean |
getBoolean()
Returns the current value of this property as an boolean. |
boolean |
getBoolean(int state)
Returns the property as a boolean. |
static Property |
getEventProperty(java.lang.String event,
java.lang.String name)
Returns a property for an existing event. |
float |
getFloat()
Returns the current value of this property as an float. |
float |
getFloat(int state)
Returns the property as a float. |
java.lang.String |
getInfo()
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D. |
int |
getInteger()
Returns the current value of this property as an integer. |
int |
getInteger(int state)
Returns the property as an integer. |
static Property |
getNodeProperty(Node node,
java.lang.String name)
Returns a property for an exisiting node. |
static Property |
getSoundProperty(java.lang.String sound,
java.lang.String name)
Returns a property for an existing sound. |
java.lang.String |
getString()
Returns the current value of this property as a string. |
java.lang.String |
getString(int state)
Return the value as a string. |
int |
getType()
Returns the type of a property. |
boolean |
isEditable()
Returns whether the property can be changed. |
void |
setBoolean(boolean num)
Sets this property the given boolean. |
void |
setFloat(float num)
Sets this property to the given float. |
void |
setInteger(int num)
Sets this property the given integer. |
void |
setString(java.lang.String str)
Sets this property the given string. |
java.lang.String |
toString()
Returns a string representation of the values of this object. |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
wait,
wait,
wait |
Field Detail |
public static final int UNKNOWN
public static final int STRING
public static final int INTEGER
public static final int BOOLEAN
public static final int FLOAT
public static final int VECTOR3D
public static final int ORIENTATION
public static final int MATRIX
public static final int INITIAL
public static final int PREVIOUS
public static final int CURRENT
Method Detail |
public static Property getNodeProperty(Node node, java.lang.String name)
node
- existing nodename
- property namepublic static Property getSoundProperty(java.lang.String sound, java.lang.String name)
sound
- sound namename
- property namepublic static Property getEventProperty(java.lang.String event, java.lang.String name)
event
- event namename
- property namepublic int getType()
public boolean isEditable()
public float getFloat()
public boolean getBoolean()
public int getInteger()
public java.lang.String getString()
public float getFloat(int state)
state
- is indicating what state value is returnedpublic int getInteger(int state)
state
- is indicating what state value is returnedpublic boolean getBoolean(int state)
state
- is indicating what state value is returnedpublic java.lang.String getString(int state)
state
- is indicating what state value is returnedpublic void setFloat(float num)
num
- is the float value to be set.public void setInteger(int num)
num
- is the integer value to be set.public void setBoolean(boolean num)
num
- is the boolean value to be set.public void setString(java.lang.String str)
public java.lang.String getInfo()
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D.
public java.lang.String toString()
Returns a string representation of the values of this object.
The string contains the name of this class.
This method is intended to be used only for debugging purposes, and the content and format of the returned string may vary between implementations and versions of Cult3D.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |