Drag[en]gine Script Module DragonScript Script API  1.0
OcclusionMesh Class Reference

Immutable occlusion mesh resources. More...

Inheritance diagram for OcclusionMesh:

Public Member Functions

Management
String getFilename ()
 Normalized filename the occlusion mesh has been loaded from. More...
 
bool equals (Object other)
 OcclusionMesh is equal to another object. More...
 
int hashCode ()
 Hash code for use as dictionary keys. More...
 

Constructors

OcclusionMesh new (String filename)
 Load occlusion mesh from file. More...
 
static void loadAsynchron (String filename, ResourceNotifier notifier)
 Load occlusion mesh from file asynchronously. More...
 

Detailed Description

Immutable occlusion mesh resources.

This is a native class. It can not be subclassed.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ equals()

bool equals ( Object  other)

OcclusionMesh is equal to another object.

Implements Object.equals(Object).

Returns
true if other is of type OcclusionMesh and both point to the same engine occlusion mesh resource.

§ getFilename()

String getFilename ( )

Normalized filename the occlusion mesh has been loaded from.

§ hashCode()

int hashCode ( )

Hash code for use as dictionary keys.

Implements Object.hashCode().

§ loadAsynchron()

static void loadAsynchron ( String  filename,
ResourceNotifier  notifier 
)
static

Load occlusion mesh from file asynchronously.

Registers a request in the game engine to load an occlusion mesh. Once finished or if the file is already loaded the notifier is used to deliver the loaded occlusion mesh or null if the loading failed.

§ new()

OcclusionMesh new ( String  filename)

Load occlusion mesh from file.

If the occlusion mesh file has been already loaded it is assigned to this object. If the occlusion mesh is not loaded yet the engine loads the occlusion mesh. This call blocks until the occlusion mesh is fully loaded and ready to be used. For asynchronous loading use loadAsynchron(). Multiple objects can point to the same loaded occlusion mesh resource. Once no object instance uses an occlusion mesh file anymore it is released from memory.


The documentation for this class was generated from the following file: