Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
OmarEmaraDev committed Mar 16, 2017
2 parents efee7f2 + bbedd63 commit f45e240
Show file tree
Hide file tree
Showing 91 changed files with 261 additions and 263 deletions.
Binary file removed all_animation_nodes.blend
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/boolean/boolean_input.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Boolean Input

Description
-----------
This node output a boolean. (A True or False)
This node outputs a boolean value. (A True or False)

.. image:: images/boolean_input_node.png
:width: 160pt
Expand Down
10 changes: 5 additions & 5 deletions docs/user_guide/nodes/boolean/boolean_list_logic.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Boolean List Logic

Description
-----------
This node return ``True`` if all of the value are ``True`` or ``False`` if all
the value are ``False`` and the inverse of the operations.
This node returns ``True`` if all of the values are ``True`` or ``False`` if all
the values are ``False`` and the inverse of the operations.

.. image:: images/boolean_list_logic_node.png
:width: 160pt
Expand All @@ -13,10 +13,10 @@ Demonstration
-------------

- **All True**
Return True if all the booleans are True and False if not.
Returns True if all the booleans are True and False if not.

- **All False**
Return True if all the booleans are False and False if not.
Returns True if all the booleans are False and False if not.

- If you used a **Not** Operation that means the output is the inverse of the boolean.

Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/boolean/boolean_to_integer.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Boolean To Integer

Description
-----------
This node return 1 if the input is ``True`` and 0 if the input is ``False``.
This node returns 1 if the input is ``True`` and 0 if the input is ``False``.

.. image:: images/boolean_to_integer_node.png
:width: 160pt
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/boolean/compare.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Compare

Description
-----------
This node compares 2 values using standard mathematical inequalities like
This node compares 2 values using standard mathematical inequalities such as
>,<,<=,>=,=,=! and return ``True`` if it was satisfied and ``False`` if not.

.. image:: images/compare_node.png
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/boolean/invert_boolean.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Invert Boolean

Description
-----------
This node invert the boolean. In other word, if the input is ``False`` it
This node inverts the boolean. In other words, if the input is ``False`` it
becomes ``True`` and if it was ``True`` it will be ``False``.

.. image:: images/invert_boolean_node.png
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/boolean/logic_operators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Logic Operators

Description
-----------
This node perform standard logical gates operations like ``And, Or, Xor``.
This node performs standard logical gates operations like ``And, Or, Xor``.

.. image:: images/logic_operators_node.png
:width: 160pt
Expand All @@ -20,10 +20,10 @@ Demonstration
e.g. ``True or True = True``, ``True or False = True``, ``False or False = False``.

- **A xor B**
If A and B are different then the output is ``True``.
If A and B are different, then the output is ``True``.
e.g. ``True xor True = False``, ``True xor false = True``, ``False xor False = False``.

- If you used a **Not** Operation that means the output is the inverse of the boolean.
- If you used a **Not** Operation, that means the output is the inverse of the boolean.

Inputs
------
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/boolean/switch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Switch

Description
-----------
This node return the first input if the condition was ``True`` and the second
This node returns the first input if the condition was ``True`` and the second
input if the condition was ``False``.

.. image:: images/switch_node.png
Expand All @@ -12,7 +12,7 @@ input if the condition was ``False``.
Inputs
------

- **Condition** - A boolean that define the output.
- **Condition** - A boolean that defines the output.
- **If True** - The value that should be the output if the condition is ``True``.
- **If False** - The value that should be the output if the condition is ``False``.

Expand All @@ -30,7 +30,7 @@ Advanced Node Settings
Note
----

The type of the node change automatically when you input another data type.
The type of the node changes automatically when you input another data type.

Examples of Usage
-----------------
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/color/choose_color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Choose Color

Description
-----------
This node output a color data you choosed from the color picker.
This node outputs color data chosen from the color picker.

.. image:: images/choose_color_node.png
:width: 160pt
Expand All @@ -26,4 +26,4 @@ Advanced Node Settings
Examples of Usage
-----------------

.. image:: gifs/choose_color_node_example.gif
.. image:: gifs/choose_color_node_example.gif
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/color/mix_colors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Mix Colors

Description
-----------
This node mix between 2 colors by a defined factor.
This node mixes between 2 colors by a defined factor.

.. image:: images/mix_colors_node.png
:width: 160pt
Expand All @@ -12,7 +12,7 @@ Inputs
------

- **Factor**
A float that control the amount of each color input to the output.
A float that controls the amount of each color input to the output.
0 means the first color only and 1 means the second color only.


Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/color/separate_color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Separate Color

Description
-----------
This node decomposes an input color data and output its individual channels.
This node decomposes input color data and outputs its individual channels.
It supports RGB, HSV, HSL and YIQ color models. All are in linear color space.

.. image:: images/separate_color_node.png
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/color/set_vertex_color.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Set Vertex Color

Description
-----------
This node create a vertex color layer and fill it with a single color.
This node creates a vertex color layer and fills it with a single color.

.. image:: images/set_vertex_color_node.png
:width: 160pt
Expand All @@ -24,8 +24,8 @@ Advanced Node Settings
----------------------

- **Check Color**
If this is enabled, Animation Nodes will check if the color haven't changed
before setting the new color. If it haven't, Animation Nodes will return the
If this is enabled, Animation Nodes will check if the color has changed
before setting the new color. If it hasn't, Animation Nodes will return the
object without any change.

This will result a speed up in the execution time if you are not changing
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/geometry/intersect_polyline_plane.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ The node takes a vector list. By default the order in which the vectors are in t
list will determine the line segments. Optionally there is also an *Edge Indices*
input which (when enabled) determines the line segments.

In both cases there wil be returned (some outputs are hidden by default):
In both cases there will be returned (some outputs are hidden by default):
- a list of vectors for intersection points
- indices of edges that are cut so that u can use only those edges further
- indices of edges that are cut so that you can use only those edges further
- what side of the plane edges are on (1, -1 for above, below and 0 if cut) to help keep only part of the edges further
- Is Valid, if any intersections at all

This helps "cut" a polyline or spline with a plane, but also to create lines or splines inside respective contour.
Also may use to make level curves or section contours out of objects.
It also may be used to make level curves or section contours out of objects.
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/geometry/point_list_normal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ This node calculates the normal of a set of points (vectors) as if they were for
This is useful for extracting normals of polygons created by nodes and not from a mesh, but also it
can be used to find the normal of a plane out of 3 points instead of the above methods.

May check if the normal can be calculated by Is Valid output. For colinear points and other cases the
The Is Valid output may be used to check if the normal can be calculated. For colinear points and other cases the
normal may not be computable.
A list of min 3 different points is required.

.. note:: The order of the points matters. The flipped normal will be returned
.. note:: The order of the points matters as the flipped normal will be returned
when the input points are in reversed order.
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/geometry/project_point_on_line.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Project Point on Line

.. image:: images/project_point_on_line.png

This node provides several information:
This node provides several useful outputs:
- the location of the closest point on line (projection of the point)
- the factor [0-1] of this projection in relation to start and end of the line segment
- the distance between the point and the line
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/geometry/project_point_on_plane.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ Project Point on Plane

.. image:: images/project_point_on_plane.png

This node provides several information:
This node provides two useful outputs:
- the location of the closest point on a plane (projection of the point)
- the signed distance point to plane. Negative values mean below plane, related to normal
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/list/append_to_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Append To List
Description
-----------
This node can be used to add an extra element to a list of the same data type.
The type of the node change automatically to whatever the data type you input.
The type of the node changes automatically to whatever the data type you input.

.. image:: images/append_to_list_node.png
:width: 160pt
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/list/combine_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Description
-----------
This node is used to combine or join an arbitrary number of lists of a specific
data type. A new list can be added with the *New Input* button. A new list can
also be added by plugging it into the transperant socket.The type of the node
change automatically to whatever the data type you input.Means if you input an
also be added by plugging it into the transparent socket.The type of the node
changes automatically to whatever the data type you input. This means if you input an
integer list, the list type will be integer.

.. image:: images/combine_list_node.png
Expand All @@ -16,7 +16,7 @@ Inputs
------

- **List** - A list of elements indexed starting from 0.
- **List** - A list of elements indexed starting the last element of the previouse list.
- **List** - A list of elements indexed starting the last element of the previous list.
- **List** - ...

Outputs
Expand Down
10 changes: 5 additions & 5 deletions docs/user_guide/nodes/list/create_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Description
-----------
This node is used to create an arbitrary list of a specific data type. A new
element can be added with the *New Input* button. A new element can also be
added by plugging it into the transperant socket. The type of the node change
added by plugging it into the transparent socket. The type of the node change
automatically to whatever the data type you input.
Means if you input an integer, the list type will be integer.
This means if you input an integer, the list type will be integer.

.. image:: images/create_list_node.png
:width: 160pt
Expand All @@ -26,9 +26,9 @@ Outputs
Advanced Node Settings
-----------------------

- **Change type** - Change the type of the list to another list type.
- **Hide Inputs** - Hide all the inputs in the node.
- **Remove Inputs** - Remove all the inputs.
- **Change type** - Changes the type of the list to another list type.
- **Hide Inputs** - Hides all the inputs in the node.
- **Remove Inputs** - Removes all the inputs.

Caution
-------
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/list/get_list_element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Get List Element
Description
-----------
This node return the element at the input index. So if the input index is 1 and
the input list is [1,2,3] then the output will be 2. (Notice that indices starts from 0 and not 1)
the input list is [1,2,3] then the output will be 2. (Notice that indices start from 0 and not 1)

.. image:: images/get_list_element_node.png
:width: 160pt
Expand All @@ -17,7 +17,7 @@ Inputs
- **Fallback**
This value is an arbitrary value that is output at a certain condition:
If **Clamp Index** is disabled and the input index is out of the range of
the input list and If the input list has no elements. So if the input list
the input list and If the input list has no elements. If the input list
is **[1,2,3]** and the index is **3** and **Clamp Index** is disabled then
the output will be equal to the **Fallback** because the list has 3 elements
only which means that the greatest index is 2.
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/list/get_list_length.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ Get List Length

Description
-----------
This node return the number of elements in the input list.
This node returns the number of elements in the input list.

.. image:: images/get_list_length_node.png
:width: 160pt

Inputs
------

- **List** - An input list.

Outputs
Expand Down
6 changes: 3 additions & 3 deletions docs/user_guide/nodes/list/get_random_list_element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Get Random List Element

Description
-----------
This node return single or multiple random list elements.
This node returns single or multiple random list elements.

.. image:: images/get_random_list_element_node.png
:width: 160pt
Expand All @@ -18,7 +18,7 @@ Inputs
Outputs
-------

- **List** - A list that contain random elements from the input list.
- **List** - A list that contains random elements from the input list.

Advanced Node Settings
----------------------
Expand All @@ -33,7 +33,7 @@ between nodes with the same seed, e.g., When using multiple *Get Random List Ele
nodes in a loop while using the index as a seed, you can change the extra seed to get
different results from the other nodes.

Animation Nodes automatically change the *Node Seed* when you duplicate or add a
Animation Nodes automatically changes the *Node Seed* when you duplicate or add a
new *Get Random List Element* node.

Examples of Usage
Expand Down
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/list/get_struct_list_elements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Description
-----------
This node takes a list of structs and output all the values of a specific common key between them.

So if a list of structs all have a key named Name and you want to output all the
If a list of structs all have a key named Name and you want to output all the
names in that key, you first have to convert the type of the node to be String
because names are strings and then type Name in the field.

Expand Down
12 changes: 6 additions & 6 deletions docs/user_guide/nodes/list/remove_list_element.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Remove List Element

Description
-----------
This node remove certain list elements based on their index or their values.
The type of the node change automatically to whatever the data type you input.
This node removes certain list elements based on their index or their values.
The type of the node changes automatically to whatever the data type you input.

.. image:: images/remove_list_element_node.png
:width: 160pt
Expand All @@ -13,16 +13,16 @@ Options
-------

- **First Occurrence**
This option remove the input value the at its first apperance only. So if the
This option removes the input value the at its first apperance only. So if the
input value is 1 and the input list is ``[1,2,3,1]`` the ouput list will be
``[2,3,1]``. Notice hat the last 1 didn't change.

- **All Occurrence**
This option remove all the input values from the list.
So for the previouse example the output list will be [2,3].
This option removes all the input values from the list.
So for the previous example the output list will be [2,3].

- **Index**
This option removes the element at the input index.So for the previouse example
This option removes the element at the input index.So for the previous example
with input index as 1 then the output will be ``[1,3,1]`` because 2 was at index 1.

Inputs
Expand Down

0 comments on commit f45e240

Please sign in to comment.