- class eradiate.scenes.shapes.RectangleShape(id='shape', bsdf=None, edges=_Nothing.NOTHING, center=_Nothing.NOTHING, normal=_Nothing.NOTHING, up=_Nothing.NOTHING)#
Rectangle shape [
This shape represents a rectangle parametrized by the length of its edges, the coordinates of its central point, a normal vector and an orientation vector.
str, optional, default:
"shape") – Identifier of the current scene element.
dict, optional) – BSDF attached to the shape. If a dictionary is passed, it is interpreted by
bsdf_factory.convert(). If unset, no BSDF will be specified during the kernel dictionary generation: the kernel’s default will be used. If a
BSDFinstance (or a corresponding dictionary specification) is passed, its id member is automatically overridden.
normal (array-like, optional, default:
1]) – Normal vector of the plane containing the rectangle. Defaults to the +Z direction.
up (array-like, optional, default:
0]) – Orientation vector defining the rotation of the rectangle around the normal vector. Defaults to the +Y direction.
None) – BSDF attached to the shape.
quantity) – Length of the rectangle’s edges.
quantity) – Cartesian coordinates of the rectangle’s central point.
normal (array) – Normal vector of the plane containing the rectangle.
up (array) – Orientation vector defining the rotation of the rectangle around the normal vector.
- classmethod surface(altitude=<Quantity(0.0, 'kilometer')>, width=<Quantity(1.0, 'kilometer')>, bsdf=None)#
This class method constructor provides a simplified parametrization of the rectangle shape better suited for the definition of the surface when configuring the one-dimensional model.
The resulting rectangle shape is a square with edge length equal to width, centred at [0, 0, altitude], with normal vector +Z.
RectangleShape– A rectangle shape which can be used as the surface in a plane parallel geometry.
Traverse this scene element and collect kernel dictionary template and parameter update map contributions.
SceneTraversal) – Callback data structure storing the collected data.
Enforce internal state consistency. This method should be called when fields are modified. It is automatically called as a post-init step.
- property objects#
Map of child objects associated with this scene element.
dict– A dictionary mapping object names to a corresponding object to be inserted in the Eradiate scene graph.
- property params#
- property template#
Kernel dictionary template contents associated with this scene element.