honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/modifier/pattern/colortext.py

@@ -0,0 +1,73 @@
+"""Radiance Colortext Pattern.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Colortext
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Colortext(Pattern):
+    """Radiance Colortext Pattern.
+
+    Colortext is dichromatic writing in a polygonal font. The font is defined in an
+    auxiliary file, such as helvet.fnt. The text itself is also specified in a separate
+    file, or can be part of the material arguments. The character size, orientation,
+    aspect ratio and slant is determined by right and down motion vectors. The upper left
+    origin for the text block as well as the foreground and background colors must also
+    be given.
+
+    .. code-block:: shell
+
+        mod colortext id
+        2 fontfile textfile
+        0
+        15+
+                Ox Oy Oz
+                Rx Ry Rz
+                Dx Dy Dz
+                rfore gfore bfore
+                rback gback bback
+                [spacing]
+
+    or:
+
+    .. code-block:: shell
+
+        mod colortext id
+        2+N fontfile . This is a line with N words ...
+        0
+        15+
+                Ox Oy Oz
+                Rx Ry Rz
+                Dx Dy Dz
+                rfore gfore bfore
+                rback gback bback
+                [spacing]
+
+    Args:
+        identifier: Text string for a unique Material ID. Must not contain spaces
+            or special characters. This will be used to identify the object across
+            a model and in the exported Radiance files.
+        modifier: Modifier. It can be primitive, mixture, texture or pattern.
+            (Default: None).
+        values: An array 3 arrays for primitive data. Each of the 3 sub-arrays
+            refer to a line number in the radiance primitive definitions and the
+            values in each array correspond to values occurring within each line.
+        is_opaque: A boolean to indicate whether this primitive is opaque.
+        dependencies: A list of primitives that this primitive depends on. This
+            argument is only useful for defining advanced primitives that are
+            defined based on other primitives. (Default: []).
+
+    Properties:
+        * identifier
+        * display_name
+        * values
+        * modifier
+        * dependencies
+        * is_modifier
+        * is_material
+        * is_opaque
+    """
+    __slots__ = ()
+
+    pass

honeybee_radiance/modifier/pattern/patternbase.py

@@ -0,0 +1,34 @@
+"""Base Radiance Pattern class.
+
+Patterns are used to modify the reflectance of materials.
+More information on Radiance Patterns can be found at:
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Patterns
+"""
+from ..modifierbase import Modifier
+
+
+class Pattern(Modifier):
+    """Base class for Radiance patterns.
+
+    Patterns are used to modify the reflectance of materials.
+
+    Properties:
+        * identifier
+        * display_name
+        * values
+        * modifier
+        * dependencies
+        * is_modifier
+        * is_material
+        * is_texture
+        * is_pattern
+        * is_mixture
+        * is_opaque
+    """
+    __slots__ = ()
+
+    @property
+    def is_pattern(self):
+        """Get a boolean noting whether this object is a pattern modifier."""
+        return True

honeybee_radiance/modifier/texture/__init__.py

@@ -0,0 +1,4 @@
+"""Radiance Textures."""
+
+from .texdata import Texdata
+from .texfunc import Texfunc

honeybee_radiance/modifier/texture/texdata.py

@@ -0,0 +1,29 @@
+"""Radiance Texdata Texture.
+
+A texture is a perturbation of the surface normal, and is given by either a function or
+data.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Texdata
+"""
+from .texturebase import Texture
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Texdata(Texture):
+    """Radiance Texdata Material.
+
+    A texdata texture uses three data files to get the surface normal perturbations. The
+    variables xfunc, yfunc and zfunc take three arguments each from the interpolated
+    values in xdfname, ydfname and zdfname.
+
+    .. code-block:: shell
+
+        mod texdata id
+        8+ xfunc yfunc zfunc xdfname ydfname zdfname vfname x0 x1 .. xf
+        0
+        n A1 A2 .. An
+
+    """
+    __slots__ = ()
+
+    pass

honeybee_radiance/modifier/texture/texfunc.py

@@ -0,0 +1,26 @@
+"""Radiance Texfunc Texture.
+
+A texture is a perturbation of the surface normal, and is given by either a function or
+data.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Texfunc
+"""
+from .texturebase import Texture
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Texfunc(Texture):
+    """Radiance Texfunc Material.
+
+    A texfunc uses an auxiliary function file to specify a procedural texture:
+
+    .. code-block:: shell
+
+        mod texfunc id
+        4+ xpert ypert zpert funcfile transform
+        0
+        n A1 A2 .. An
+    """
+    __slots__ = ()
+
+    pass

honeybee_radiance/modifier/texture/texturebase.py

@@ -0,0 +1,27 @@
+"""Base Radiance Texture class (Texfunc, Texdata).
+
+A texture is a perturbation of the surface normal, and is given by either a
+function or a data set. More information on Radiance Textures can be found at:
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Textures
+"""
+from ..modifierbase import Modifier
+
+
+class Texture(Modifier):
+    """Base class for Radiance texture (Texfunc, Texdata).
+
+    Properties:
+        * name
+        * values
+        * modifier
+        * dependencies
+        * is_modifier
+        * is_texture
+    """
+    __slots__ = ()
+
+    @property
+    def is_texture(self):
+        """Get a boolean noting whether this object is a texture modifier."""
+        return True