Module org.arakhne.afc.core.mathtree

Package org.arakhne.afc.math.tree.node

Enum OctTreeNode.OctTreeZone

java.lang.Object

java.lang.Enum<OctTreeNode.OctTreeZone>

org.arakhne.afc.math.tree.node.OctTreeNode.OctTreeZone

All Implemented Interfaces:

Serializable, Comparable<OctTreeNode.OctTreeZone>

Enclosing class:

OctTreeNode<D,N extends OctTreeNode<D,N>>

public static enum OctTreeNode.OctTreeZone
extends Enum<OctTreeNode.OctTreeZone>

This is the generic implementation of a tree for which each node has eight children.

Since:

13.0

Version:

17.0 2020-01-04 14:41:41

Author:

Stéphane GALLAND

Maven Group Id:

org.arakhne.afc.core

Maven Artifact Id:

mathtree

Enum Constant Summary

Enum Constants

Enum Constant	Description
NORTH_EAST_BACK	This is the index of the child that correspond to the voxel at north-east and back position.
NORTH_EAST_FRONT	This is the index of the child that correspond to the voxel at north-east and front position.
NORTH_WEST_BACK	This is the index of the child that correspond to the voxel at north-west and back position.
NORTH_WEST_FRONT	This is the index of the child that correspond to the voxel at north-west and front position.
SOUTH_EAST_BACK	This is the index of the child that correspond to the voxel at south-east and back position.
SOUTH_EAST_FRONT	This is the index of the child that correspond to the voxel at south-east and front position.
SOUTH_WEST_BACK	This is the index of the child that correspond to the voxel at south-west and back position.
SOUTH_WEST_FRONT	This is the index of the child that correspond to the voxel at south-west and front position.

Method Summary

Modifier and Type	Method	Description
static OctTreeNode.OctTreeZone	fromInteger(int index)	Replies the zone corresponding to the given index.
static OctTreeNode.OctTreeZone	valueOf(String name)	Returns the enum constant of this type with the specified name.
static OctTreeNode.OctTreeZone[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NORTH_WEST_FRONT

public static final OctTreeNode.OctTreeZone NORTH_WEST_FRONT

This is the index of the child that correspond to the voxel at north-west and front position.

NORTH_WEST_BACK

public static final OctTreeNode.OctTreeZone NORTH_WEST_BACK

This is the index of the child that correspond to the voxel at north-west and back position.

NORTH_EAST_FRONT

public static final OctTreeNode.OctTreeZone NORTH_EAST_FRONT

This is the index of the child that correspond to the voxel at north-east and front position.

NORTH_EAST_BACK

public static final OctTreeNode.OctTreeZone NORTH_EAST_BACK

This is the index of the child that correspond to the voxel at north-east and back position.

SOUTH_WEST_FRONT

public static final OctTreeNode.OctTreeZone SOUTH_WEST_FRONT

This is the index of the child that correspond to the voxel at south-west and front position.

SOUTH_WEST_BACK

public static final OctTreeNode.OctTreeZone SOUTH_WEST_BACK

This is the index of the child that correspond to the voxel at south-west and back position.

SOUTH_EAST_FRONT

public static final OctTreeNode.OctTreeZone SOUTH_EAST_FRONT

This is the index of the child that correspond to the voxel at south-east and front position.

SOUTH_EAST_BACK

public static final OctTreeNode.OctTreeZone SOUTH_EAST_BACK

This is the index of the child that correspond to the voxel at south-east and back position.

Method Detail

values

public static OctTreeNode.OctTreeZone[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (OctTreeNode.OctTreeZone c : OctTreeNode.OctTreeZone.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static OctTreeNode.OctTreeZone valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromInteger

@Pure
public static OctTreeNode.OctTreeZone fromInteger(int index)

Replies the zone corresponding to the given index. The index is the same as the ordinal value of the enumeration. If the given index does not correspond to an ordinal value, null is replied.

Parameters:

index - the index.

Returns:

the zone or null