honeybee-radiance 1.66.190__py3-none-any.whl

honeybee_radiance/modifier/mixture/mixdata.py

@@ -0,0 +1,49 @@
+"""Radiance Mixdata Mixture.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Mixdata
+"""
+from .mixturebase import Mixture
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Mixdata(Mixture):
+    """Radiance Mixdata Material.
+
+    Mixdata combines two modifiers using an auxiliary data file:
+
+    .. code-block:: shell
+
+        mod mixdata id
+        5+n+
+                foreground background func datafile
+                funcfile x1 x2 .. xn transform
+        0
+        m A1 A2 .. Am
+
+    Args:
+        identifier: Text string for a unique Mixture 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/mixture/mixfunc.py

@@ -0,0 +1,54 @@
+"""Radiance Mixfunc Mixture.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Mixfunc
+"""
+from .mixturebase import Mixture
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Mixfunc(Mixture):
+    """Radiance Mixfunc Material.
+
+    A mixfunc mixes two modifiers procedurally. It is specified as follows:
+
+    .. code-block:: shell
+
+        mod mixfunc id
+        4+ foreground background vname funcfile transform
+        0
+        n A1 A2 .. An
+
+    Foreground and background are modifier names that must be defined earlier in the
+    scene description. If one of these is a material, then the modifier of the mixfunc
+    must be "void". (Either the foreground or background modifier may be "void", which
+    serves as a form of opacity control when used with a material.) Vname is the
+    coefficient defined in funcfile that determines the influence of foreground. The
+    background coefficient is always (1-vname).
+
+    Args:
+        identifier: Text string for a unique Mixture 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/mixture/mixpict.py

@@ -0,0 +1,52 @@
+"""Radiance Mixpict Mixture.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Mixpict
+"""
+from .mixturebase import Mixture
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Mixpict(Mixture):
+    """Radiance Mixpict Material.
+
+    Mixpict combines two modifiers based on a picture:
+
+    .. code-block:: shell
+
+        mod mixpict id
+        7+
+                foreground background func pictfile
+                funcfile u v transform
+        0
+        m A1 A2 .. Am
+
+    The mixing coefficient function "func" takes three arguments, the red, green and
+    blue values corresponding to the pixel at (u,v).
+
+    Args:
+        identifier: Text string for a unique Mixture 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/mixture/mixtext.py

@@ -0,0 +1,66 @@
+"""Radiance Mixtext Mixture.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Mixtext
+"""
+from .mixturebase import Mixture
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Mixtext(Mixture):
+    """Radiance Mixtext Material.
+
+    Mixtext uses one modifier for the text foreground, and one for the background:
+
+    .. code-block:: shell
+
+        mod mixtext id
+        4 foreground background fontfile textfile
+        0
+        9+
+                Ox Oy Oz
+                Rx Ry Rz
+                Dx Dy Dz
+                [spacing]
+
+    or:
+
+    .. code-block:: shell
+
+        mod mixtext id
+        4+N
+                foreground background fontfile .
+                This is a line with N words ...
+        0
+        9+
+                Ox Oy Oz
+                Rx Ry Rz
+                Dx Dy Dz
+                [spacing]
+
+    Args:
+        identifier: Text string for a unique Mixture 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/mixture/mixturebase.py

@@ -0,0 +1,28 @@
+"""Base Radiance Mixture class.
+
+A mixture is a blend of one or more materials or textures and patterns. Blended
+materials should not be light source types or virtual source types.
+More information on Radiance Mixtures can be found at:
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Mixtures
+"""
+from ..modifierbase import Modifier
+
+
+class Mixture(Modifier):
+    """Base class for Radiance mixtures.
+
+    Properties:
+        * identifier
+        * display_name
+        * values
+        * modifier
+        * dependencies
+        * is_mixture
+    """
+    __slots__ = ()
+
+    @property
+    def is_mixture(self):
+        """Get a boolean noting whether this object is a mixture modifier."""
+        return True

honeybee_radiance/modifier/modifierbase.py

@@ -0,0 +1,40 @@
+"""Base Radiance Modifier class.
+
+A modifier is anything that can be applied to geometry in order to modify its
+reflectance, transmittance, etc. It includes Radiance materials as well as
+patterns, textures and mixtures of other modifiers.
+
+Modifiers can also be used to modify other modifiers in addition to modifying
+geometry. More information on Radiance Modifiers can be found at:
+
+https://floyd.lbl.gov/radiance/refer/ray.html
+"""
+from ..primitive import Primitive
+
+
+class Modifier(Primitive):
+    """Base class for Radiance modifiers.
+
+    Properties:
+        * identifier
+        * display_name
+        * values
+        * modifier
+        * dependencies
+        * is_modifier
+        * is_material
+        * is_texture
+        * is_pattern
+        * is_mixture
+        * is_opaque
+    """
+
+    __slots__ = ()
+
+    @property
+    def is_modifier(self):
+        """Get a boolean indicating whether this object is a Radiance modifier.
+
+        Modifiers include materials, mixtures, textures and patterns.
+        """
+        return True

honeybee_radiance/modifier/pattern/__init__.py

@@ -0,0 +1,9 @@
+"""Radiance Patterns."""
+
+from .brightdata import Brightdata
+from .brightfunc import Brightfunc
+from .brighttext import Brighttext
+from .colordata import Colordata
+from .colorfunc import Colorfunc
+from .colorpict import Colorpict
+from .colortext import Colortext

honeybee_radiance/modifier/pattern/brightdata.py

@@ -0,0 +1,49 @@
+"""Radiance Brightdata Texture.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Brightdata
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Brightdata(Pattern):
+    """Radiance Brightdata Material.
+
+    Brightdata is like colordata, except monochromatic.
+
+    .. code-block:: shell
+
+        mod brightdata id
+        3+n+
+                func datafile
+                funcfile x1 x2 .. xn transform
+        0
+        m A1 A2 .. Am
+
+    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/brightfunc.py

@@ -0,0 +1,47 @@
+"""Radiance Brightfunc Pattern.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Brightfunc
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Brightfunc(Pattern):
+    """Radiance Brightfunc Material.
+
+    A brightfunc is the same as a colorfunc, except it is monochromatic.
+
+    .. code-block:: shell
+
+        mod brightfunc id
+        2+ refl funcfile transform
+        0
+        n A1 A2 .. An
+
+    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/brighttext.py

@@ -0,0 +1,81 @@
+"""Radiance Brighttext Pattern.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Brighttext
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Brighttext(Pattern):
+    """Radiance Brighttext Pattern.
+
+    Brighttext is like colortext, but the writing is monochromatic.
+
+    .. code-block:: shell
+
+        mod brighttext id
+        2 fontfile textfile
+        0
+        11+
+                Ox Oy Oz
+                Rx Ry Rz
+                Dx Dy Dz
+                foreground background
+                [spacing]
+
+    or:
+
+    .. code-block:: shell
+
+        mod brighttext id
+        2+N fontfile . This is a line with N words ...
+        0
+        11+
+                Ox Oy Oz
+                Rx Ry Rz
+                Dx Dy Dz
+                foreground background
+                [spacing]
+
+    By default, a uniform spacing algorithm is used that guarantees every character will
+    appear in a precisely determined position. Unfortunately, such a scheme results in
+    rather unattractive and difficult to read text with most fonts. The optional spacing
+    value defines the distance between characters for proportional spacing. A positive
+    value selects a spacing algorithm that preserves right margins and indentation, but
+    does not provide the ultimate in proportionally spaced text. A negative value insures
+    that characters are properly spaced, but the placement of words then varies
+    unpredictably. The choice depends on the relative importance of spacing versus
+    formatting. When presenting a section of formatted text, a positive spacing value is
+    usually preferred. A single line of text will often be accompanied by a negative
+    spacing value. A section of text meant to depict a picture, perhaps using a special
+    purpose font such as hexbit4x1.fnt, calls for uniform spacing. Reasonable magnitudes
+    for proportional spacing are between 0.1 (for tightly spaced characters) and 0.3 (for
+    wide 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/colordata.py

@@ -0,0 +1,56 @@
+"""Radiance Colordata Pattern.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Colordata
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Colordata(Pattern):
+    """Radiance Colordata Pattern.
+
+    Colordata uses an interpolated data map to modify a material's color. The map is
+    n-dimensional, and is stored in three auxiliary files, one for each color. The
+    coordinates used to look up and interpolate the data are defined in another auxiliary
+    file. The interpolated data values are modified by functions of one or three
+    variables. If the functions are of one variable, then they are passed the
+    corresponding color component (red or green or blue). If the functions are of three
+    variables, then they are passed the original red, green, and blue values as
+    parameters.
+
+    .. code-block:: shell
+
+        mod colordata id
+        7+n+
+                rfunc gfunc bfunc rdatafile gdatafile bdatafile
+                funcfile x1 x2 .. xn transform
+        0
+        m A1 A2 .. Am
+
+    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/colorfunc.py

@@ -0,0 +1,47 @@
+"""Radiance Colorfunc Texture.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Colorfunc
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Colorfunc(Pattern):
+    """Radiance Colorfunc Material.
+
+    A colorfunc is a procedurally defined color pattern. It is specified as follows:
+
+    .. code-block:: shell
+
+        mod colorfunc id
+        4+ red green blue funcfile transform
+        0
+        n A1 A2 .. An
+
+    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/colorpict.py

@@ -0,0 +1,54 @@
+"""Radiance Colorpict Pattern.
+
+http://radsite.lbl.gov/radiance/refer/ray.html#Colorpict
+"""
+from .patternbase import Pattern
+
+
+# TODO: Implement the class. It's currently only a generic Radiance Primitive
+class Colorpict(Pattern):
+    """Radiance Colorpict Pattern.
+
+    Colorpict is a special case of colordata, where the pattern is a two-dimensional
+    image stored in the RADIANCE picture format. The dimensions of the image data are
+    determined by the picture such that the smaller dimension is always 1, and the
+    other is the ratio between the larger and the smaller. For example, a 500x338
+    picture would have coordinates (u,v) in the rectangle between (0,0) and (1.48,1).
+
+    .. code-block:: shell
+
+        mod colorpict id
+        7+
+                rfunc gfunc bfunc pictfile
+                funcfile u v transform
+        0
+        m A1 A2 .. Am
+
+    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