Update terrain.

[mikumikustudio/MikuMikuStudio.git] / engine / src / terrain / com / jme3 / terrain / geomipmap / TerrainGridListener.java

diff --git a/engine/src/terrain/com/jme3/terrain/geomipmap/TerrainGridListener.java b/engine/src/terrain/com/jme3/terrain/geomipmap/TerrainGridListener.java
index 38e0001..cb25cae 100644 (file)
--- a/engine/src/terrain/com/jme3/terrain/geomipmap/TerrainGridListener.java
+++ b/engine/src/terrain/com/jme3/terrain/geomipmap/TerrainGridListener.java
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2009-2010 jMonkeyEngine
+ * Copyright (c) 2009-2012 jMonkeyEngine
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -31,18 +31,31 @@
  */
 package com.jme3.terrain.geomipmap;
 
-import com.jme3.material.Material;
 import com.jme3.math.Vector3f;
 
 /**
- *
+ * Notifies the user of grid change events, such as moving to new grid cells.
  * @author Anthyon
  */
 public interface TerrainGridListener {
 
+    /**
+     * Called whenever the camera has moved full grid cells. This triggers new tiles to load.
+     * @param newCenter 
+     */
     public void gridMoved(Vector3f newCenter);
 
+    /**
+     * Called when a TerrainQuad is attached to the scene and is visible (attached to the root TerrainGrid)
+     * @param cell the cell that is moved into
+     * @param quad the quad that was just attached
+     */
     public void tileAttached( Vector3f cell, TerrainQuad quad );
 
+    /**
+     * Called when a TerrainQuad is detached from its TerrainGrid parent: it is no longer on the scene graph.
+     * @param cell the cell that is moved into
+     * @param quad the quad that was just detached
+     */
     public void tileDetached( Vector3f cell, TerrainQuad quad );
 }