Update Doc

iplai · Oct 27, 2023 · 699c05e · 699c05e
1 parent 9ad8be1
commit 699c05e
Show file tree

Hide file tree

Showing 64 changed files with 658 additions and 181 deletions.
diff --git a/docs/apidocs/pynodes/pynodes.core.rst b/docs/apidocs/pynodes/pynodes.core.rst
@@ -600,7 +600,7 @@ API
       .. autodoc2-docstring:: pynodes.core.Tree.frame
          :parser: myst
 
-   .. py:method:: simulate(*input_sockets: pynodes.core.Socket)
+   .. py:method:: simulate(*input_sockets: pynodes.core.Socket, fakes: list[int] | int = None)
       :canonical: pynodes.core.Tree.simulate
 
       .. autodoc2-docstring:: pynodes.core.Tree.simulate
@@ -772,7 +772,7 @@ API
    .. autodoc2-docstring:: pynodes.core.SimulationZone.__init__
       :parser: myst
 
-   .. py:method:: to_output(socket: pynodes.core.Socket, index=0)
+   .. py:method:: to_output(socket: pynodes.core.Socket, index=1)
       :canonical: pynodes.core.SimulationZone.to_output
 
       .. autodoc2-docstring:: pynodes.core.SimulationZone.to_output
@@ -925,7 +925,7 @@ API
    .. autodoc2-docstring:: pynodes.core.frame
       :parser: myst
 
-.. py:function:: simulate(*input_sockets: pynodes.core.Socket)
+.. py:function:: simulate(*input_sockets: pynodes.core.Socket, fakes: list[int] | int = None)
    :canonical: pynodes.core.simulate
 
    .. autodoc2-docstring:: pynodes.core.simulate

diff --git a/docs/apidocs/pynodes/pynodes.datasocks.rst b/docs/apidocs/pynodes/pynodes.datasocks.rst
@@ -427,8 +427,8 @@ Functions
      - .. autodoc2-docstring:: pynodes.datasocks.ShaderNodeVectorTransform
           :parser: myst
           :summary:
-   * - :py:obj:`ShaderNodeBlackbody <pynodes.datasocks.ShaderNodeBlackbody>`
-     - .. autodoc2-docstring:: pynodes.datasocks.ShaderNodeBlackbody
+   * - :py:obj:`Blackbody <pynodes.datasocks.Blackbody>`
+     - .. autodoc2-docstring:: pynodes.datasocks.Blackbody
           :parser: myst
           :summary:
    * - :py:obj:`ShaderNodeCombineColor <pynodes.datasocks.ShaderNodeCombineColor>`
@@ -560,6 +560,12 @@ API
       .. autodoc2-docstring:: pynodes.datasocks.Float.to_string
          :parser: myst
 
+   .. py:method:: to_blackbody()
+      :canonical: pynodes.datasocks.Float.to_blackbody
+
+      .. autodoc2-docstring:: pynodes.datasocks.Float.to_blackbody
+         :parser: myst
+
    .. py:method:: clamp(clamp_type='MINMAX', min=0.0, max=1.0)
       :canonical: pynodes.datasocks.Float.clamp
 
@@ -1255,6 +1261,12 @@ API
       .. autodoc2-docstring:: pynodes.datasocks.Vector.line_towards
          :parser: myst
 
+   .. py:method:: to_white_noise(noise_dimensions='3D', w=0.0)
+      :canonical: pynodes.datasocks.Vector.to_white_noise
+
+      .. autodoc2-docstring:: pynodes.datasocks.Vector.to_white_noise
+         :parser: myst
+
    .. py:method:: switch(switch=False, true_vector=(0.0, 0.0, 0.0))
       :canonical: pynodes.datasocks.Vector.switch
 
@@ -1465,7 +1477,7 @@ API
       .. autodoc2-docstring:: pynodes.datasocks.Vector.normalized
          :parser: myst
 
-   .. py:method:: absolute()
+   .. py:property:: absolute
       :canonical: pynodes.datasocks.Vector.absolute
 
       .. autodoc2-docstring:: pynodes.datasocks.Vector.absolute
@@ -1519,6 +1531,12 @@ API
       .. autodoc2-docstring:: pynodes.datasocks.Vector.fraction
          :parser: myst
 
+   .. py:property:: fract
+      :canonical: pynodes.datasocks.Vector.fract
+
+      .. autodoc2-docstring:: pynodes.datasocks.Vector.fract
+         :parser: myst
+
    .. py:method:: modulo(other=(0.0, 0.0, 0.0))
       :canonical: pynodes.datasocks.Vector.modulo
 
@@ -2051,7 +2069,7 @@ API
       .. autodoc2-docstring:: pynodes.datasocks.Color.alpha
          :parser: myst
 
-   .. py:method:: mix(b_color=(0.5, 0.5, 0.5, 1.0), blend_type='MIX', factor=0.5, clamp_factor=True, clamp_result=False)
+   .. py:method:: mix(b_color=(0.5, 0.5, 0.5, 1.0), factor=0.5, blend_type='MIX', clamp_factor=True, clamp_result=False)
       :canonical: pynodes.datasocks.Color.mix
 
       .. autodoc2-docstring:: pynodes.datasocks.Color.mix
@@ -2543,6 +2561,12 @@ API
       .. autodoc2-docstring:: pynodes.datasocks.BsdfPrincipled.emission
          :parser: myst
 
+   .. py:property:: emission_color
+      :canonical: pynodes.datasocks.BsdfPrincipled.emission_color
+
+      .. autodoc2-docstring:: pynodes.datasocks.BsdfPrincipled.emission_color
+         :parser: myst
+
    .. py:property:: emission_strength
       :canonical: pynodes.datasocks.BsdfPrincipled.emission_strength
 
@@ -2943,7 +2967,7 @@ API
    .. autodoc2-docstring:: pynodes.datasocks.MixVector
       :parser: myst
 
-.. py:function:: MixColor(a_color=(0.5, 0.5, 0.5, 1.0), b_color=(0.5, 0.5, 0.5, 1.0), blend_type='MIX', factor=0.5, clamp_factor=True, clamp_result=False)
+.. py:function:: MixColor(a_color=(0.5, 0.5, 0.5, 1.0), b_color=(0.5, 0.5, 0.5, 1.0), factor=0.5, blend_type='MIX', clamp_factor=True, clamp_result=False)
    :canonical: pynodes.datasocks.MixColor
 
    .. autodoc2-docstring:: pynodes.datasocks.MixColor
@@ -3135,10 +3159,10 @@ API
    .. autodoc2-docstring:: pynodes.datasocks.ShaderNodeVectorTransform
       :parser: myst
 
-.. py:function:: ShaderNodeBlackbody(temperature=1500.0)
-   :canonical: pynodes.datasocks.ShaderNodeBlackbody
+.. py:function:: Blackbody(temperature=1500.0)
+   :canonical: pynodes.datasocks.Blackbody
 
-   .. autodoc2-docstring:: pynodes.datasocks.ShaderNodeBlackbody
+   .. autodoc2-docstring:: pynodes.datasocks.Blackbody
       :parser: myst
 
 .. py:function:: ShaderNodeCombineColor(red=0.0, green=0.0, blue=0.0, mode='RGB')

diff --git a/docs/apidocs/pynodes/pynodes.geosocks.rst b/docs/apidocs/pynodes/pynodes.geosocks.rst
@@ -199,6 +199,12 @@ API
       .. autodoc2-docstring:: pynodes.geosocks.Geometry.__getitem__
          :parser: myst
 
+   .. py:method:: __mul__(other)
+      :canonical: pynodes.geosocks.Geometry.__mul__
+
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.__mul__
+         :parser: myst
+
    .. py:property:: selection
       :canonical: pynodes.geosocks.Geometry.selection
 
@@ -539,6 +545,12 @@ API
       .. autodoc2-docstring:: pynodes.geosocks.Geometry.remove_attribute
          :parser: myst
 
+   .. py:method:: remove_attributes(*names: list[str])
+      :canonical: pynodes.geosocks.Geometry.remove_attributes
+
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.remove_attributes
+         :parser: myst
+
    .. py:method:: _store_named_attribute(data_type='FLOAT', domain='POINT', selection=True, name='', value_vector=(0.0, 0.0, 0.0), value_float=0.0, value_color=(0.0, 0.0, 0.0, 0.0), value_bool=False, value_int=0)
       :canonical: pynodes.geosocks.Geometry._store_named_attribute
 
@@ -551,6 +563,12 @@ API
       .. autodoc2-docstring:: pynodes.geosocks.Geometry.store_named_attribute
          :parser: myst
 
+   .. py:method:: store_integer(domain='POINT', selection=True, **kwargs)
+      :canonical: pynodes.geosocks.Geometry.store_integer
+
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.store_integer
+         :parser: myst
+
    .. py:method:: store_named_attributes(data: dict[str], domain='POINT', selection=True)
       :canonical: pynodes.geosocks.Geometry.store_named_attributes
 
@@ -706,10 +724,10 @@ API
       .. autodoc2-docstring:: pynodes.geosocks.Geometry.sample_nearest_on_corners
          :parser: myst
 
-   .. py:method:: bound_box()
-      :canonical: pynodes.geosocks.Geometry.bound_box
+   .. py:method:: bounding_box()
+      :canonical: pynodes.geosocks.Geometry.bounding_box
 
-      .. autodoc2-docstring:: pynodes.geosocks.Geometry.bound_box
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.bounding_box
          :parser: myst
 
    .. py:method:: convex_hull()
@@ -772,6 +790,24 @@ API
       .. autodoc2-docstring:: pynodes.geosocks.Geometry.transform
          :parser: myst
 
+   .. py:method:: translate(translation=(0.0, 0.0, 0.0))
+      :canonical: pynodes.geosocks.Geometry.translate
+
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.translate
+         :parser: myst
+
+   .. py:method:: rotate(rotation=(0.0, 0.0, 0.0))
+      :canonical: pynodes.geosocks.Geometry.rotate
+
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.rotate
+         :parser: myst
+
+   .. py:method:: scale(scale=(1.0, 1.0, 1.0))
+      :canonical: pynodes.geosocks.Geometry.scale
+
+      .. autodoc2-docstring:: pynodes.geosocks.Geometry.scale
+         :parser: myst
+
    .. py:method:: separate_components()
       :canonical: pynodes.geosocks.Geometry.separate_components
 
@@ -1996,7 +2032,7 @@ API
       .. autodoc2-docstring:: pynodes.geosocks.Mesh.sample_uv_surface_boolean
          :parser: myst
 
-   .. py:method:: set_shade_smooth(shade_smooth=True, selection=True)
+   .. py:method:: set_shade_smooth(shade_smooth=True, domain='FACE', selection=True)
       :canonical: pynodes.geosocks.Mesh.set_shade_smooth
 
       .. autodoc2-docstring:: pynodes.geosocks.Mesh.set_shade_smooth
@@ -2197,12 +2233,24 @@ API
    .. autodoc2-docstring:: pynodes.geosocks.Points.__init__
       :parser: myst
 
+   .. py:method:: to_curves(curve_group_id=0, weight=0.0)
+      :canonical: pynodes.geosocks.Points.to_curves
+
+      .. autodoc2-docstring:: pynodes.geosocks.Points.to_curves
+         :parser: myst
+
    .. py:property:: domain_size
       :canonical: pynodes.geosocks.Points.domain_size
 
       .. autodoc2-docstring:: pynodes.geosocks.Points.domain_size
          :parser: myst
 
+   .. py:property:: point_count
+      :canonical: pynodes.geosocks.Points.point_count
+
+      .. autodoc2-docstring:: pynodes.geosocks.Points.point_count
+         :parser: myst
+
    .. py:method:: merge_by_distance(distance=0.001, mode='ALL', selection=True)
       :canonical: pynodes.geosocks.Points.merge_by_distance
 

diff --git a/docs/apidocs/pynodes/pynodes.nodes.rst b/docs/apidocs/pynodes/pynodes.nodes.rst
@@ -1061,6 +1061,10 @@ Functions
      - .. autodoc2-docstring:: pynodes.nodes.GeometryNodeIndexOfNearest
           :parser: myst
           :summary:
+   * - :py:obj:`GeometryNodePointsToCurves <pynodes.nodes.GeometryNodePointsToCurves>`
+     - .. autodoc2-docstring:: pynodes.nodes.GeometryNodePointsToCurves
+          :parser: myst
+          :summary:
 
 API
 ~~~
@@ -1689,7 +1693,7 @@ API
    .. autodoc2-docstring:: pynodes.nodes.GeometryNodeSampleUVSurface
       :parser: myst
 
-.. py:function:: GeometryNodeSetShadeSmooth(geometry=None, selection=True, shade_smooth=True)
+.. py:function:: GeometryNodeSetShadeSmooth(domain='FACE', geometry=None, selection=True, shade_smooth=True)
    :canonical: pynodes.nodes.GeometryNodeSetShadeSmooth
 
    .. autodoc2-docstring:: pynodes.nodes.GeometryNodeSetShadeSmooth
@@ -2630,3 +2634,9 @@ API
 
    .. autodoc2-docstring:: pynodes.nodes.GeometryNodeIndexOfNearest
       :parser: myst
+
+.. py:function:: GeometryNodePointsToCurves(points=None, curve_group_id=0, weight=0.0)
+   :canonical: pynodes.nodes.GeometryNodePointsToCurves
+
+   .. autodoc2-docstring:: pynodes.nodes.GeometryNodePointsToCurves
+      :parser: myst
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: c65c95da6f60a035834ebacac559a41c
+config: 04f03e6392885cd73fc9b922084eb318
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_sources/apidocs/pynodes/pynodes.core.rst.txt b/docs/build/html/_sources/apidocs/pynodes/pynodes.core.rst.txt
@@ -600,7 +600,7 @@ API
       .. autodoc2-docstring:: pynodes.core.Tree.frame
          :parser: myst
 
-   .. py:method:: simulate(*input_sockets: pynodes.core.Socket)
+   .. py:method:: simulate(*input_sockets: pynodes.core.Socket, fakes: list[int] | int = None)
       :canonical: pynodes.core.Tree.simulate
 
       .. autodoc2-docstring:: pynodes.core.Tree.simulate
@@ -772,7 +772,7 @@ API
    .. autodoc2-docstring:: pynodes.core.SimulationZone.__init__
       :parser: myst
 
-   .. py:method:: to_output(socket: pynodes.core.Socket, index=0)
+   .. py:method:: to_output(socket: pynodes.core.Socket, index=1)
       :canonical: pynodes.core.SimulationZone.to_output
 
       .. autodoc2-docstring:: pynodes.core.SimulationZone.to_output
@@ -925,7 +925,7 @@ API
    .. autodoc2-docstring:: pynodes.core.frame
       :parser: myst
 
-.. py:function:: simulate(*input_sockets: pynodes.core.Socket)
+.. py:function:: simulate(*input_sockets: pynodes.core.Socket, fakes: list[int] | int = None)
    :canonical: pynodes.core.simulate
 
    .. autodoc2-docstring:: pynodes.core.simulate