Skip to content

Latest commit

 

History

History
72 lines (44 loc) · 4.05 KB

kitchen_cabinet.md

File metadata and controls

72 lines (44 loc) · 4.05 KB
Raw

KitchenCabinet

from tdw.proc_gen.arrangements.kitchen_cabinet import KitchenCabinet

Abstract class for kitchen counters, wall cabinets, and sinks. These all shared the same canonical rotation and height.

Class Variables

Variable Type Description Value
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())

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.

Functions

__init__

KitchenCabinet(cabinetry, wall, corner, distance, region)

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

Parameter Type Default Description
cabinetry Cabinetry The Cabinetry set.
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.
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.