Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
OmarEmaraDev committed Mar 18, 2017
2 parents 5cb0f02 + 14c9c7a commit a06e17f
Show file tree
Hide file tree
Showing 14 changed files with 61 additions and 61 deletions.
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/mesh/bmesh_from_mesh_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Bmesh From Mesh Data

Description
-----------
This node convert mesh data block into a Bmesh block.
This node converts a mesh data block into a Bmesh block.

.. image:: images/bmesh_from_mesh_data_node.png
:width: 160pt
Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/nodes/mesh/bmesh_from_object.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Bmesh From Object

Description
-----------
This node return a bmesh data type for the input object.
This node returns a bmesh data type for the input object.

A bmesh data type is created using blender's bmesh python module which support operations that can't be performed normally in bpy module and thus can't be applied on a normal mesh data type, some of this operations are implimented in AN like **Limited Dissolve** and **Remove Doubles**.
A bmesh data type is created using blender's bmesh python module which support operations that can't be performed normally in bpy module and thus can't be applied on a normal mesh data type, some of these operations are implimented in AN like **Limited Dissolve** and **Remove Doubles**.

It is not recommended to use this node if you are not going to use bmesh operations and just want to get mesh data, because it is a lot slower to create.(Object Mesh Data node can get the same data in about 33x the speed of the bmesh)

Expand All @@ -16,8 +16,8 @@ Inputs
------

- **Object** - An object.
- **Use World Space** - This option allow you to choose between local and global coordiate space for the output vectors (vertices location).
- **Use Modifiers** - This option if enabled will return the data as modifiers were applied, that include both the generative and defomative modifiers.
- **Use World Space** - This option allows you to choose between local and global coordiate space for the output vectors (vertices location).
- **Use Modifiers** - This option if enabled will return the data as modifiers were applied, that includes both the generative and defomative modifiers.
- **Scene** - `To Do`

Outputs
Expand Down
12 changes: 6 additions & 6 deletions docs/user_guide/nodes/mesh/bmesh_mesh_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Bmesh Mesh Data

Description
-----------
This node return the mesh data of the input bmesh.
This node returns the mesh data of the input bmesh.

.. image:: images/bmesh_mesh_data_node.png
:width: 160pt
Expand All @@ -16,17 +16,17 @@ Inputs
Outputs
-------

- **Vertex Locations** - A vector list that include vertices locations of the input bmesh.
- **Edge Indices** - A list of edge indices that include all the edges of the input bmesh.
- **Polygon Indices** - A list of polygon indices that include all the polygons of the input bmesh.
- **Vertex Locations** - A vector list that includes vertices locations of the input bmesh.
- **Edge Indices** - A list of edge indices that includes all the edges of the input bmesh.
- **Polygon Indices** - A list of polygon indices that includes all the polygons of the input bmesh.
- **Vertices** - A list of vertex data for each vertex in the input bmesh. (see notes)
- **Polygons** - A list of polygon data for each polygon in the input bmesh. (see notes)

Advanced Node Settings
----------------------

**Weighted Center** - The polygons data type carry a vector that represent the the center of the polygon.
If this option is disabled, the center is basically the average of the vertices locations of the polygon, or in more mathematical word, The scalars of the convex combination of the vertices of the polygon are all equal and is equal to the reciprocal of the number of vertices in that polygon.
If this option is disabled, the center is basically the average of the vertices locations of the polygon, or in more mathematical terms, The scalars of the convex combination of the vertices of the polygon are all equal and is equal to the reciprocal of the number of vertices in that polygon.
If this option is enabled, the scalars of each vertex of the convex combination of the vertices of the polygon will be directly proportional to the length of the two edges it is connected to.
This option solve dispersion issue, where if we had a polygon that consist of 10 vertices, 9 of them are in a small area and one of them is far away, the average ceneter will be so close to the 9 vertices and very far from the single vertex, however the weighted center will have a center at equal distance from both the single and the 9 vertices.

Expand All @@ -35,7 +35,7 @@ This option solve dispersion issue, where if we had a polygon that consist of 10
Notes
-----

- **Vertices** output is a data type that carry more information about the vertex like its normal and its weight in vertex groups and you can get them using the **Vertex Info** node, so if all you want is the location of the vertices then the **Vertex Location** output is the right output for the job.And the same apply for **Polygons**.
- **Vertices** output is a data type that carries more information about the vertex like its normal and its weight in vertex groups and you can get them using the **Vertex Info** node, so if all you want is the location of the vertices then the **Vertex Location** output is the right output for the job. The same apply for **Polygons**.

Examples of Usage
-----------------
Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/nodes/mesh/combine_mesh_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ Combine Mesh Data

Description
-----------
This node combine individual mesh data into a mesh data block.
This node combines individual mesh data into a mesh data block.

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

Inputs
------

- **Vertex Locations** - A vector list that contain the locations of the vertices of the input mesh data.
- **Edges Indices** - An edge indices list that contain the edge information of the input mesh data.
- **Polygons Indices** - A polygon indices list that contain the polygon information of the input mesh data.
- **Vertex Locations** - A vector list that contains the locations of the vertices of the input mesh data.
- **Edges Indices** - An edge indices list that contains the edge information of the input mesh data.
- **Polygons Indices** - A polygon indices list that contains the polygon information of the input mesh data.

Outputs
-------
Expand Down
14 changes: 7 additions & 7 deletions docs/user_guide/nodes/mesh/get_bounding_box.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Get Bounding Box

Description
-----------
This node return mesh data of a cuboid that represent the bounding box of the input object.
This node returns mesh data of a cuboid that represents the bounding box of the input object.

A bounding box is a box that bound the object, that is, each face of the box is a least upper bound or greatest lower bound of a specific vertex coordinate.
A bounding box is a box that bounds the object, that is, each face of the box is a least upper bound or greatest lower bound of a specific vertex coordinate.

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

- **Vertices** - A vector list that include vertices locations of the bounding box.
- **Edges** - A list of edge indices that include all the edges of the bounding box.
- **Polygons** - A list of polygon indices that include all the polygons of the bounding box.
- **Vertices** - A vector list that includes vertices locations of the bounding box.
- **Edges** - A list of edge indices that includes all the edges of the bounding box.
- **Polygons** - A list of polygon indices that includes all the polygons of the bounding box.

Advanced Node Settings
----------------------

- **Use World Space** - This option allow you to choose between local and global coordinate space for the bounding box.
- **Use World Space** - This option allows you to choose between local and global coordinate space for the bounding box.

Examples of Usage
-----------------

It is not every day where you would create a bounding box or visualize it. This node is useful as it actually gives you the ability to determine the maximum and minimum value of the vertex coordinates at a certain axis, and you may use it to perform normalization for instance.

In other words, if I were to calculate the x coordinate of the vertex that has the highest x coordinate (The maximum x value of all vertices) I can just get the x coordinates of the vertex at index 6---It represent the intersection of the least upper bounds in all axis so its x coordinate is the maximum x and its y is the maximum y and its z is the maximum z---The same apply for the minimum but this time the vertex at index zero is sampled.
In other words, if I were to calculate the x coordinate of the vertex that has the highest x coordinate (The maximum x value of all vertices) I can just get the x coordinates of the vertex at index 6---It represents the intersection of the least upper bounds in all axis so its x coordinate is the maximum x and its y is the maximum y and its z is the maximum z---The same applies for the minimum but this time the vertex at index zero is sampled.
2 changes: 1 addition & 1 deletion docs/user_guide/nodes/mesh/join_mesh_data_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Join Mesh Data List

Description
-----------
This node combine multiple mesh data blocks into a single block of mesh data.
This node combines multiple mesh data blocks into a single block of mesh data.

.. image:: images/join_mesh_data_list_node.png
:width: 160pt
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/mesh/mesh_data_from_polygons.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Mesh Data From Polygons

Description
-----------
This node create mesh data block from a list of polygons.
This node creates a mesh data block from a list of polygons.

You may think that this node create mesh data from just polygons, but in fact, the polygon data block contain the vertices locations that create each polygon, however, indices are not provided so the resulted mesh data will have faces that are separated from each other.
You may think that this node create mesh data from just polygons, but in fact, the polygon data block contains the vertices locations that create each polygon, however, indices are not provided so the resultant mesh data will have faces that are separated from each other.

.. image:: images/mesh_data_from_polygons_node.png
:width: 160pt
Expand Down
12 changes: 6 additions & 6 deletions docs/user_guide/nodes/mesh/mesh_data_list.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Mesh Data List

Description
-----------
This node is used to create an arbitrary list of mesh data. A new mesh data can be added with the *New Input* button. A new mesh data can also be added by plugging it into the transperant socket.
This node is used to create an arbitrary list of mesh data. A new mesh data can be added with the *New Input* button. A new mesh data can also be added by plugging it into the transparent socket.

.. image:: images/mesh_data_list_node.png
:width: 160pt
Expand All @@ -17,18 +17,18 @@ Inputs

Outputs
-------
- **Mesh Data list** - A list that contain all the input mesh data.
- **Mesh Data list** - A list that contains all the input mesh data.

Advanced Node Settings
----------------------

- **Change type** - Change the type of the mesh data 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 mesh data list to another list type.
- **Hide Inputs** - Hides all the inputs in the node.
- **Remove Inputs** - Removes all the inputs.

Caution
-------
A warning pop up when you use the *Remove All* button in the node, while if you used the the *Remove All* button in the *Advanced Node Settings* the inputs will be removed without a warning.
A warning pops up when you use the *Remove All* button in the node, while if you used the the *Remove All* button in the *Advanced Node Settings* the inputs will be removed without a warning.

Examples of Usage
-----------------
Expand Down
12 changes: 6 additions & 6 deletions docs/user_guide/nodes/mesh/object_mesh_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Object Mesh Data

Description
-----------
This node return some data about the input object like its vertices and polygons info. The data is from blender's object data block, which means, when the object is edited in edit mode, **AN** won't update the output data unless you change to object mode.
This node returns some data about the input object like its vertices and polygons info. The data is from blender's object data block, which means, when the object is edited in edit mode, **AN** won't update the output data unless you change to object mode.

.. image:: images/object_mesh_data_node.png
:width: 160pt
Expand All @@ -13,18 +13,18 @@ Inputs

- **Object** - An object.
- **Use World Space** - This option allow you to choose between local and global coordinate space for the output vectors (vertices location).
- **Use Modifiers** - This option if enabled will return the data as modifiers were applied, that include both the generative and defomative modifiers.
- **Use Modifiers** - This option if enabled will return the data as modifiers were applied, that includes both the generative and defomative modifiers.
- **Scene** - `To Do`

Outputs
-------

- **Vertex Locations** - A vector list that include vertices locations of the input object.
- **Edge Indices** - A list of edge indices that include all the edges of the input object.
- **Polygon Indices** - A list of polygon indices that include all the polygons of the input object.
- **Vertex Locations** - A vector list that includes vertices locations of the input object.
- **Edge Indices** - A list of edge indices that includes all the edges of the input object.
- **Polygon Indices** - A list of polygon indices that includes all the polygons of the input object.
- **Vertices** - A list of vertex data for each vertex in the input object. (see notes)
- **Polygons** - A list of polygon data for each polygon in the input object. (see notes)
- **Mesh Name** - A string that contain the name of the mesh.
- **Mesh Name** - A string that contains the name of the mesh.

Advanced Node Settings
----------------------
Expand Down
14 changes: 7 additions & 7 deletions docs/user_guide/nodes/mesh/object_output.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,24 @@ Object Output

Description
-----------
This node edit the input object's data based on a new input data.
This node edits the input object's data based on a new input data.

.. image:: images/mesh_object_output_node.png
:width: 200pt

Options
-------
- **Mesh Data** - This option let you write a mesh data block to the input object. Since the mesh data block carry only the vertices locations,edge indices and polygons indices info, those data will be the only data in the output object. (A bmesh data block carry more information than the mesh data block like vertices normals.)
- **Bmesh** - This option let you write a bmesh data block to the input object. A bmesh data block carry much more information than the mesh data block, such extra informations like *Vertex Normals*, *Vertex group weights* and *Material indices*.
- **Vertices** - This option will only edit the vertices locations, that is, the input object should already have some data and you are just editing the vertices locations of these data. This option is much faster than the **Mesh Data** option assuming all you do is editing the vertices.
- **Mesh Data** - This option lets you write a mesh data block to the input object. Since the mesh data block carries only the vertices locations, edge, indices, and polygons indices info, those will be the only data in the output object. (A bmesh data block carries more information than the mesh data block like vertices normals.)
- **Bmesh** - This option lets you write a bmesh data block to the input object. A bmesh data block carry much more information than the mesh data block, such extra informations like *Vertex Normals*, *Vertex group weights* and *Material indices*.
- **Vertices** - This option will only edit the vertices locations, that is, the input object should already have some data and you are just editing the vertices locations of this data. This option is much faster than the **Mesh Data** option assuming all you do is edit the vertices.

Inputs
------

- **Object** - An object to edit, The plus button let you add a new object and write to it.
- **Mesh Data** - A mesh data to write to the input object. (Only for the Mesh Data option)
- **Bmesh** - A bmesh to write to the input object. (Only for the Bmesh option)
- **Vertices** - A vector list that represent the new locations for the vertices. (Only for the vertices option)
- **Mesh Data** - Mesh data to write to the input object. (Only for the Mesh Data option)
- **Bmesh** - Bmesh to write to the input object. (Only for the Bmesh option)
- **Vertices** - Vector list that represents the new locations for the vertices. (Only for the vertices option)
- **Material Indices** - An integer list, the 1st integer represent the index of the material of the 1st polygon, the 2nd integer represent the index of the material of the 2nd polygon, ....


Expand Down
12 changes: 6 additions & 6 deletions docs/user_guide/nodes/mesh/polygon_info.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Polygon Info

Description
-----------
This node return some information about the input polygon.
This node returns some information about the input polygon.

.. image:: images/polygon_info_node.png
:width: 160pt
Expand All @@ -16,11 +16,11 @@ Inputs
Outputs
-------

- **Vertex Locations** - A vector list that contain the locations of all the vertices forming the input polygon.
- **Center** - A vector that represent the center of the polygon.
- **Normal** - A unit vector that represent the normal of the input polygon.
- **Area** - A float that represent the area of the input polygon.
- **Material Index** - An integer that represent the index of the material which the input polygon is assigned to.
- **Vertex Locations** - A vector list that contains the locations of all the vertices forming the input polygon.
- **Center** - A vector that represents the center of the polygon.
- **Normal** - A unit vector that represents the normal of the input polygon.
- **Area** - A float that represents the area of the input polygon.
- **Material Index** - An integer that represents the index of the material which the input polygon is assigned to.

Advanced Node Settings
----------------------
Expand Down
8 changes: 4 additions & 4 deletions docs/user_guide/nodes/mesh/separate_mesh_data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Separate Mesh Data

Description
-----------
This node separate the input mesh data into it's components:
This node separates the input mesh data into it's components:

- **Vertex Locations**.
- **Edge Indices**.
Expand All @@ -20,9 +20,9 @@ Inputs
Outputs
-------

- **Vertex Locations** - A vector list that contain the locations of the vertices of the input mesh data.
- **Edges Indices** - An edge indices list that contain the edge information of the input mesh data.
- **Polygons Indices** - A polygon indices list that contain the polygon information of the input mesh data.
- **Vertex Locations** - A vector list that contains the locations of the vertices of the input mesh data.
- **Edges Indices** - An edge indices list that contains the edge information of the input mesh data.
- **Polygons Indices** - A polygon indices list that contains the polygon information of the input mesh data.

Advanced Node Settings
----------------------
Expand Down
4 changes: 2 additions & 2 deletions docs/user_guide/nodes/mesh/transform_polygon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@ Transform Vector

Description
-----------
This node transform an input polygon based on an input transformation matrix.
This node transforms an input polygon based on an input transformation matrix.

It support using the **Center** of the polygon, the center of the **world** `(0,0,0)` and a **custom** vector as a pivot for the transformation
It supports using the **Center** of the polygon, the center of the **world** `(0,0,0)` and a **custom** vector as a pivot for the transformation

.. image:: images/transform_polygon_node.png
:width: 160pt
Expand Down

0 comments on commit a06e17f

Please sign in to comment.