Shelf

from tdw.proc_gen.arrangements.shelf import Shelf

Shelving with objects on the shelves.

• The shelf model is chosen randomly; see Shelf.MODEL_CATEGORIES["shelf"].
• The shelf is placed next to a wall.
  • The shelf's position is automatically adjusted to set it flush to the wall.
  • The shelf is automatically rotated so that it faces away from the wall.
• Each shelf of the object has a rectangular arrangement of objects. See: Shelf.CELL_SIZE, Shelf.CELL_DENSITY, Shelf.WIDTH_SCALE, and Shelf.DEPTH_SCALE.
  • The objects are chosen randomly; see Shelf.ON_TOP_OF["shelf"].
  • The objects are positioned in a rectangular grid on each shelf with random positional perturbations.
  • The objects have random rotations (0 to 360 degrees).
• The shelf object is kinematic.

---

Fields

• send_commands If True, send commands when self.get_commands() is called. If False, self.get_commands() will return an empty list.

• root_object_id The ID of the root object.

• object_ids A list of all of the object IDs in this arrangement.

• root_object_id The ID of the root object.

• object_ids A list of all of the object IDs in this arrangement.

• object_ids A list of all of the object IDs in this arrangement.

---

Class Variables

Variable	Type	Description	Value
CELL_DENSITY	float	The probability from 0 to 1 of a "cell" in the shelf rectangular arrangements being empty. Lower value = a higher density of small objects.	0.8
CELL_SIZE	float	The size of each cell in the shelf rectangular arrangements. This controls the minimum size of objects and the density of the arrangement.	0.0125
DEFAULT_CELL_SIZE	float	The default span used for arranging objects next to each other.	0.6096
ENCLOSED_BY	Dict[str, List[str]]	A dictionary of categories that can be enclosed by other categories. Key = A category. Value = A list of categories of models that can enclosed by the key category.	loads(Path(resource_filename(__name__, "data/enclosed_by.json")).read_text())
INSIDE_OF	Dict[str, List[str]]	A dictionary of categories that can be inside of other categories. Key = A category. Value = A list of categories of models that can inside of the key category.	loads(Path(resource_filename(__name__, "data/inside_of.json")).read_text())
MODEL_CATEGORIES	Dict[str, List[str]]	A dictionary of all of the models that may be used for procedural generation. Key = The category. Value = A list of model names. Note that this category overlaps with, but is not the same as, model_record.wcategory; see: Arrangement.get_categories_and_wcategories().	loads(Path(resource_filename(__name__, "data/models.json")).read_text())
ON_TOP_OF	Dict[str, List[str]]	A dictionary of categories that can be on top of other categories. Key = A category. Value = A list of categories of models that can be on top of the key category.	loads(Path(resource_filename(__name__, "data/on_top_of.json")).read_text())

---

Functions

__init__

__init__

Shelf(wall, corner, distance, region)

Shelf(wall, corner, distance, region, model=None, wall_length=None, rng=None)

Parameter	Type	Default	Description
wall	CardinalDirection		The wall as a CardinalDirection that the root object is next to.
corner	OrdinalDirection		The origin OrdinalDirection of this wall. This is used to derive the direction.
distance	float		The distance in meters from the corner along the derived direction.
region	InteriorRegion		The InteriorRegion that the object is in.
model	Union[str, ModelRecord]	None	Either the name of the model (in which case the model must be in models_core.json), or a ModelRecord, or None. If None, a model that fits along the wall at distance is randomly selected. If no model fits, the arrangement will not be added to the scene.
wall_length	float	None	The total length of the lateral arrangement. If None, defaults to the length of the wall.
rng	Union[int, np.random.RandomState]	None	Either a random seed or an numpy.random.RandomState object. If None, a new random number generator is created.

get_categories_and_wcategories

Arrangement.get_categories_and_wcategories()

(Static)

Returns: A dictionary of the categories of every model that can be used by Arrangement and their corresponding wcategory and wnid. Key = The model name. Value = A dictionary with the following keys: "category" (the ProcGenObjects category), "wcategory" (the value of record.wcategory), and "wnid" (the value of record.wnid).

get_commands

self.get_commands()

Returns: A list of commands that will generate the arrangement.

get_length

self.get_length()

Returns: The lateral extent of the object.