ChunkView

java.lang.Object
- se.llbit.chunky.world.ChunkView

```
public class ChunkView
extends java.lang.Object
```
Abstract representation of a view over a map of chunks.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BLOCK_SCALE_MAX` Maximum block scale for the map view.
`static int`	`BLOCK_SCALE_MIN` Minimum block scale for the map view.
`int`	`chunkScale`
`int`	`cx0`
`int`	`cx1`
`int`	`cz0`
`int`	`cz1`
`static int`	`DEFAULT_BLOCK_SCALE` Default block scale for the map view.
`static ChunkView`	`EMPTY` A zero-size chunk view useful as a default chunk view for an uninitialized map.
`int`	`height`
`int`	`layer`
`int`	`prx0`
`int`	`prx1`
`int`	`prz0`
`int`	`prz1`
`int`	`px0`
`int`	`px1`
`int`	`pz0`
`int`	`pz1`
`MapViewMode`	`renderer`
`int`	`scale`
`int`	`width`
`double`	`x`
`double`	`x0`
`double`	`x1`
`double`	`z`
`double`	`z0`
`double`	`z1`

Constructor Summary

Constructors
Constructor and Description
`ChunkView(ChunkView other)`
`ChunkView(double x, double z, int width, int height, int scale, MapViewMode renderer, int layer)`
`ChunkView(double x, double z, int width, int height, MapViewMode renderer, int layer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`clampScale(int scale)` Clamp the block scale to the minimum / maximum values if it is outside the valid value range.
`boolean`	`equals(java.lang.Object obj)`
`boolean`	`isChunkVisible(ChunkPosition chunk)`
`boolean`	`isChunkVisible(int x, int z)`
`boolean`	`isRegionVisible(ChunkPosition pos)`
`boolean`	`isRegionVisible(int x, int z)`
`boolean`	`isVisible(ChunkPosition pos)`
`boolean`	`shouldPreload(Chunk chunk)`
`boolean`	`shouldPreload(ChunkPosition pos)` Determines if a chunk or region is visible based on the view scale.
`boolean`	`shouldRepaint(ChunkView other)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BLOCK_SCALE_MIN
```
public static final int BLOCK_SCALE_MIN
```
Minimum block scale for the map view.

See Also:

Constant Field Values

BLOCK_SCALE_MAX
```
public static final int BLOCK_SCALE_MAX
```
Maximum block scale for the map view.

See Also:

Constant Field Values

DEFAULT_BLOCK_SCALE
```
public static final int DEFAULT_BLOCK_SCALE
```
Default block scale for the map view.

See Also:

Constant Field Values

EMPTY
```
public static final ChunkView EMPTY
```
A zero-size chunk view useful as a default chunk view for an uninitialized map.

renderer
```
public final MapViewMode renderer
```

layer
```
public final int layer
```

x
```
public final double x
```

z
```
public final double z
```

x0
```
public final double x0
```

z0
```
public final double z0
```

x1
```
public final double x1
```

z1
```
public final double z1
```

cx0
```
public final int cx0
```

cz0
```
public final int cz0
```

cx1
```
public final int cx1
```

cz1
```
public final int cz1
```

px0
```
public final int px0
```

pz0
```
public final int pz0
```

px1
```
public final int px1
```

pz1
```
public final int pz1
```

prx0
```
public final int prx0
```

prz0
```
public final int prz0
```

prx1
```
public final int prx1
```

prz1
```
public final int prz1
```

width
```
public final int width
```

height
```
public final int height
```

scale
```
public final int scale
```

chunkScale
```
public final int chunkScale
```

Constructor Detail

ChunkView

public ChunkView(double x,
                 double z,
                 int width,
                 int height,
                 MapViewMode renderer,
                 int layer)

ChunkView
```
public ChunkView(ChunkView other)
```

ChunkView

public ChunkView(double x,
                 double z,
                 int width,
                 int height,
                 int scale,
                 MapViewMode renderer,
                 int layer)

Method Detail
- shouldPreload
```
public boolean shouldPreload(Chunk chunk)
```
- equals
```
public boolean equals(java.lang.Object obj)
```
  Overrides:
  
  equals in class java.lang.Object
- isVisible
```
public boolean isVisible(ChunkPosition pos)
```
- shouldPreload
```
public boolean shouldPreload(ChunkPosition pos)
```
  Determines if a chunk or region is visible based on the view scale. If the scale is greater than or equal to 16 then the test is for chunk visibility, otherwise region visibility is checked.
- isChunkVisible
```
public boolean isChunkVisible(ChunkPosition chunk)
```
- isChunkVisible
```
public boolean isChunkVisible(int x,
                              int z)
```
- isRegionVisible
```
public boolean isRegionVisible(ChunkPosition pos)
```
- isRegionVisible
```
public boolean isRegionVisible(int x,
                               int z)
```
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.Object
- clampScale
```
public static int clampScale(int scale)
```
  Clamp the block scale to the minimum / maximum values if it is outside the valid value range.
  
  Returns:
  
  clamped scale value
- shouldRepaint
```
public boolean shouldRepaint(ChunkView other)
```
  Parameters:
  
  other - the previous view state
  
  Returns:
  
  true if changing to this view from the given old view should trigger a map repaint.

Class ChunkView

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

BLOCK_SCALE_MIN

BLOCK_SCALE_MAX

DEFAULT_BLOCK_SCALE

EMPTY

renderer

layer

x

z

x0

z0

x1

z1

cx0

cz0

cx1

cz1

px0

pz0

px1

pz1

prx0

prz0

prx1

prz1

width

height

scale

chunkScale

Constructor Detail

ChunkView

ChunkView

ChunkView

Method Detail

shouldPreload

equals

isVisible

shouldPreload

isChunkVisible

isChunkVisible

isRegionVisible

isRegionVisible

toString

clampScale

shouldRepaint