# PLaSK User Manual

#### Page Contents

- Block2D Class
  - `Block2D`
  - Methods
  - Attributes
  - Descriptions
    - Method Details
      - `Block2D.contains()`
      - `Block2D.get_leafs()`
      - `Block2D.get_leafs_bboxes()`
      - `Block2D.get_leafs_positions()`
      - `Block2D.get_leafs_translations()`
      - `Block2D.get_matching_objects()`
      - `Block2D.get_material()`
      - `Block2D.get_object_bboxes()`
      - `Block2D.get_object_positions()`
      - `Block2D.get_paths()`
      - `Block2D.get_role_objects()`
      - `Block2D.get_roles()`
      - `Block2D.has_role()`
      - `Block2D.modify_objects()`
      - `Block2D.object_contains()`
      - `Block2D.validate()`
    - Attribute Details
      - `Block2D.bbox`
      - `Block2D.dims`
      - `Block2D.height`
      - `Block2D.material`
      - `Block2D.representative_material`
      - `Block2D.role`
      - `Block2D.roles`
      - `Block2D.steps`
      - `Block2D.width`

# Block2D Class

class plask.geometry.Block2D

  Rectangle(width, height, material) Rectangle(dims, material)

  Rectangular block (2D geometry object).

  Sides of the rectangle are always parallel to the axes and its origin is located in the lower left corner.

  Parameters:

    - width (float) – Rectangle width.

    - height (float) – Rectangle height.

    - material (Material) – Rectangle material.

    - dims (plask.vec) – 2D vector representing dimensions of the rectangle.

  alias of `Rectangle`

## Methods

`contains`(...) | Test if the geometry object contains a point.
`get_leafs`([path]) | Get list of the geometry tree leafs.
`get_leafs_bboxes`([path]) | Calculate bounding boxes of all the geometry tree leafs.
`get_leafs_positions`([path]) | Calculate positions of all the geometry tree leafs.
`get_leafs_translations`([path]) | Get list of `Translation` objects holding all the geometry tree leafs.
`get_matching_objects`(cond) | Get list of the geometry tree objects matching condition.
`get_material`(...) | Get material at the given point.
`get_object_bboxes`(object[, path]) | Calculate bounding boxes of all instances of specified object.
`get_object_positions`(object[, path]) | Calculate positions of all instances of the specified object.
`get_paths`(...) | Get subtree containing paths to all leafs covering the specified point.
`get_role_objects`(role) | Get list of the geometry tree objects that have the specified role.
`get_roles`(...) | Get roles of objects at specified point.
`has_role`(...) | Test if the specified point has a given role.
`modify_objects`(callable) | Modify all objects in the geometry tree.
`object_contains`(...) | Test if the specified geometry object contains a point.
`validate`() | Check if the object is complete and ready for calculations.

## Attributes

`bbox` | Minimal rectangle which contains all points of the geometry object (in local coordinates).
`dims` | Dimensions of the rectangle.
`height` | Height of the rectangle.
`material` | material of the geometry object (or None if there is no single material for the object)
`representative_material` |
`role` | Role of the object.
`roles` | List of all the roles of the object.
`steps` | Step info for mesh generation for non-uniform objects.
`width` | Width of the rectangle.

## Descriptions

### Method Details

Block2D.contains(c0, c1)
Block2D.contains(point)

  Test if the geometry object contains a point.

  Parameters:

    - point (plask.vector) – Vector with local coordinates of the tested point.

    - c0 (float) – Horizontal local coordinate of the tested point.

    - c1 (float) – Vertical local coordinate of the tested point.

  Returns:

    True if the geometry object contains the given point.

  Return type:

    bool

Block2D.get_leafs(path=None)

  Get list of the geometry tree leafs.

  This method returns all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.

  Parameters:

    path – Path that can be used to select only some leafs.

  Returns:

    List of translations of the leafs.

  Return type:

    sequence

  All these methods are guaranteed to return their sequences in the same order: `get_leafs()`, `get_leafs_bboxes()`, `get_leafs_positions()`, `get_leafs_translations()`.

Block2D.get_leafs_bboxes(path=None)

  Calculate bounding boxes of all the geometry tree leafs.

  This method computes the bounding boxes of all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.

  The bounding boxes are computed in the local coordinates of this object.

  Parameters:

    path – Path that can be used to select only some leafs.

  Returns:

    List of vectors containing the position of the leafs.

  Return type:

    sequence

  All these methods are guaranteed to return their sequences in the same order: `get_leafs()`, `get_leafs_bboxes()`, `get_leafs_positions()`, `get_leafs_translations()`.

Block2D.get_leafs_positions(path=None)

  Calculate positions of all the geometry tree leafs.

  This method computes position of all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.

  The position are computed in the local coordinates of this object.

  Parameters:

    path – Path that can be used to select only some leafs.

  Returns:

    List of vectors containing the position of the leafs.

  Return type:

    sequence

  All these methods are guaranteed to return their sequences in the same order: `get_leafs()`, `get_leafs_bboxes()`, `get_leafs_positions()`, `get_leafs_translations()`.

Block2D.get_leafs_translations(path=None)

  Get list of `Translation` objects holding all the geometry tree leafs.

  This method computes the `Translation` objects of all the geometry tree leafs located under this geometry object. By leaf we understand a proper geometry object, in contrast to any container or transformation.

  The translations are computed in the local coordinates of this object.

  Parameters:

    path – Path that can be used to select only some leafs.

  Returns:

    List of translations of the leafs.

  Return type:

    sequence

  All these methods are guaranteed to return their sequences in the same order: `get_leafs()`, `get_leafs_bboxes()`, `get_leafs_positions()`, `get_leafs_translations()`.

Block2D.get_matching_objects(cond)

  Get list of the geometry tree objects matching condition.

  This method returns all the objects in the geometry tree that match the specified condition.

  Parameters:

    cond – Python callable that accepts a geometry object and returns Boolean indicating whether the object should be returned by this method or not.

  Returns:

    List of objects matching your condition.

  Return type:

    sequence

Block2D.get_material(c0, c1)
Block2D.get_material(point)

  Get material at the given point.

  This method returns a material object with the material at the given point if this point is located within the geometry object self. Otherwise the method returns None.

  Parameters:

    - point (plask.vector) – Vector with local coordinates of the tested point.

    - c0 (float) – Horizontal local coordinate of the tested point.

    - c1 (float) – Vertical local coordinate of the tested point.

  Returns:

    Material at the specified point or None.

Block2D.get_object_bboxes(object, path=None)

  Calculate bounding boxes of all instances of specified object.

  The bounding boxes are computed in the local coordinates of self.

  Parameters:

    - object – Object to test.

    - path – Path specifying a particular object instance.

  Returns:

    List of bounding boxes of the instances of the object.

  Return type:

    sequence

  All these methods are guaranteed to return their sequences in the same order, provided they are called with the same arguments: `get_object_bboxes()`, `get_object_positions()`

Block2D.get_object_positions(object, path=None)

  Calculate positions of all instances of the specified object.

  The position are computed in the local coordinates of self.

  Parameters:

    - object – Object to test.

    - path – Path specifying a particular object instance.

  Returns:

    List of vectors containing the position of the instances of the object.

  Return type:

    sequence

  All these methods are guaranteed to return their sequences in the same order, provided they are called with the same arguments: `get_object_bboxes()`, `get_object_positions()`

Block2D.get_paths(point, all=False)
Block2D.get_paths(c0, c1, all=False)

  Get subtree containing paths to all leafs covering the specified point.

  Parameters:

    - point (plask.vector) – Vector with local coordinates of the tested point.

    - c0 (float) – Horizontal local coordinate of the tested point.

    - c1 (float) – Vertical local coordinate of the tested point.

    - all (bool) – If True then all the leafs intersecting the point are considered. Otherwise, only the path to the topmost (i.e. visible) object is returned.

  Returns:

    Subtree with the path to the specified point.

  See also

  `plask.geometry.Subtree`

Block2D.get_role_objects(role)

  Get list of the geometry tree objects that have the specified role.

  This method returns all the objects in the geometry tree that have the specified role.

  Warning

  This method will return the very object with the role specified and not its items, which is against the normal behavior of the roles.

  Parameters:

    role (str) – Role to search objects with.

  Returns:

    List of objects matching your condition.

  Return type:

    sequence

Block2D.get_roles(c0, c1)
Block2D.get_roles(point)

  Get roles of objects at specified point.

  This method returns a set of all the roles given to the every object intersecting the specified point.

  Parameters:

    - point (plask.vector) – Vector with local coordinates of the tested point.

    - c0 (float) – Horizontal local coordinate of the tested point.

    - c1 (float) – Vertical local coordinate of the tested point.

  Returns:

    Set of the roles at given point.

  Return type:

    set

Block2D.has_role(role, point)
Block2D.has_role(role, c0, c1)

  Test if the specified point has a given role.

  This method checks if any object intersecting the specified point has the role role.

  Parameters:

    - point (plask.vector) – Vector with local coordinates of the tested point.

    - c0 (float) – Horizontal local coordinate of the tested point.

    - c1 (float) – Vertical local coordinate of the tested point.

  Returns:

    True if the point has the role role.

  Return type:

    bool

Block2D.modify_objects(callable)

  Modify all objects in the geometry tree.

  This method calls `callable` on every object in the geometry tree. The `callable` takes a single geometry object as an argument and should return `None` (in which case nothing happens), a new object to replace the original one, or an empty tuple (which will result in the removal of the original object).

  Parameters:

    callable – a callable filtering each object in the tree

  Returns:

    modified geometry

  Return type:

    GeometryObject

Block2D.object_contains(object, path, point)
Block2D.object_contains(object, point)
Block2D.object_contains(object, path, c0, c1)
Block2D.object_contains(object, mesh)
Block2D.object_contains(object, c0, c1)
Block2D.object_contains(object, path, mesh)

  Test if the specified geometry object contains a point.

  The given geometry object must be located somewhere within the self geometry tree.

  Parameters:

    - object – Object to test.

    - path – Path specifying a particular object instance.

    - point (plask.vector) – Vector with local coordinates of the tested point.

    - c0 (float) – Horizontal local coordinate of the tested point.

    - c1 (float) – Vertical local coordinate of the tested point.

    - mesh (plask.mesh.Mesh) – Mesh, which points are tested.

  Returns:

    True if the specified geometry object contains the given point.

      If a mesh is tested, the return value is an array of bools.

  Return type:

    bool

Block2D.validate()

  Check if the object is complete and ready for calculations.

  This method is specific for a particular object. It raises an exception if the object definition is somehow incomplete.

### Attribute Details

Block2D.bbox = <property object>

  Minimal rectangle which contains all points of the geometry object (in local coordinates).

  See also

  `plask.geometry.Box2D`

Block2D.dims = <property object>

  Dimensions of the rectangle.

Block2D.height = <property object>

  Height of the rectangle.

Block2D.material = <property object>

  material of the geometry object (or None if there is no single material for the object)

Block2D.representative_material = <property object>

Block2D.role = <property object>

  Role of the object. Valid only if the object has only one role.

Block2D.roles = <property object>

  List of all the roles of the object.

Block2D.steps = <property object>

  Step info for mesh generation for non-uniform objects.

  This parameter is considered only for the non-uniform leafs in the geometry tree. It has two attributes that can be changed:

  `num` | Maximum number of the mesh steps in each direction the object is divided into.
  `dist` | Minimum step size.

  The exact meaning of these attributes depend on the mesh generator, however in general they indicate how densely should the non-uniform object be subdivided.

  It is possible to assign simply an integer number to this parameter, in which case it changes its `num` attribute.

Block2D.width = <property object>

  Width of the rectangle.