net.risingworld.api.utils

Class ModelInformation

java.lang.Object

net.risingworld.api.utils.ModelInformation

public final class ModelInformation
extends java.lang.Object

Represents a custom 3D model file.
It's highly recommended to create an ModelInformation object only once and reuse it every time you need it. It's safe to use the same ModelInformation reference for several players and in multiple threads.

Supported file formats: obj, blend

Constructor Summary

Constructors

Constructor and Description
ModelInformation(java.io.File file) Creates a new 3D model information object and loads a model from a file.
ModelInformation(Plugin plugin, java.lang.String resource) Creates a new model information object and loads a model from the plugin jar file.
ModelInformation(java.lang.String filepath) Creates a new model information object and loads a model from a file.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
BoundingInformation	getBoundingInformation() Gets a BoundingInformation which describes the extents of the model, i.e.
java.lang.String	getChecksum() Gets the MD5 checksum of this file.
byte[]	getData() Gets the byte data of the file.
java.lang.String	getExtension() Gets the file extension.
java.lang.String	getFilename() Gets the filename.
int	hashCode()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ModelInformation

public ModelInformation(Plugin plugin,
                        java.lang.String resource)

Creates a new model information object and loads a model from the plugin jar file.

Parameters:

plugin - a reference to the plugin. This is required to make sure the game loads the resource from the correct plugin jar.

resource - the path to the resource (inside the jar file).

Example: Load object "car.obj" from jar file (in package rw.plugin.models)

1	// if ModelInformation is created in "Plugin" class
2	ModelInformation info = new ModelInformation(this, "/rw/plugin/models/car.obj");
3	// do something with the model info

ModelInformation

public ModelInformation(java.lang.String filepath)

Creates a new model information object and loads a model from a file.

Parameters:

filepath - the path to the model file on the harddrive.

See Also:

ModelInformation(java.io.File)

Example: Load model "car.obj" from "assets" subfolder in plugin directory

1	ModelInformation info = new ModelInformation(getPath() + "/assets/car.obj");
2	// do something with the model info

ModelInformation

public ModelInformation(java.io.File file)

Creates a new 3D model information object and loads a model from a file.

Parameters:

file - the file representing the path to the model on the harddrive.

See Also:

ModelInformation(java.lang.String)

Method Detail

getBoundingInformation

public BoundingInformation getBoundingInformation()

Gets a BoundingInformation which describes the extents of the model, i.e. the actual center as well as the x, y and z extent (half extent). The BoundingInformation will be cached after the first call, so if this function gets called again, it does not recreate a new BoundingInformation object.

Returns:

a BoundingInformation which describes the extents of this model.

Example:

1	ModelInformation modelInfo = new ModelInformation(getPath() + "/assets/myModel.obj");
2
3	//Calling getBoundingInformation() does the same...
4	BoundingInformation info1 = modelInfo.getBoundingInformation();
5
6	//...as creating a new BoundingInformation by passing the ModelInformation
7	BoundingInformation info2 = new BoundingInformation(modelInfo);

getData

public byte[] getData()

Gets the byte data of the file.

Returns:

a byte array representing the file, or null if no data is set.

getFilename

public java.lang.String getFilename()

Gets the filename.

Returns:

the filename.

getExtension

public java.lang.String getExtension()

Gets the file extension.

Returns:

the file extension.

getChecksum

public java.lang.String getChecksum()

Gets the MD5 checksum of this file.

Returns:

the MD5 checksum, as a String.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object