griefith/test2
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Doc: Updated comments for the 'corner space' of custom normals.

Browse Source
This commit is contained in:
Bastien Montagne
2024-12-20 11:12:41 +01:00
parent 175ad18368
commit 4b89a0047f
2 changed files with 44 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
source/blender/blenkernel/BKE_mesh.h
View File

@@ -229,18 +229,37 @@ bool BKE_mesh_vert_normals_are_dirty(const Mesh *mesh);
bool BKE_mesh_face_normals_are_dirty(const Mesh *mesh);
/**
* References a contiguous loop-fan with normal offset vars.
* References a contiguous loop-fan.
* Combined with the automatically calculated face corner normal, this gives a dimensional
* coordinate space used to convert normals between the "custom normal" #short2 representation and
* a regular #float3 format.
*/
struct MLoopNorSpace {
/** Automatically computed loop normal. */
/** The automatically computed face corner normal, not including influence of custom normals. */
float vec_lnor[3];
/** Reference vector, orthogonal to vec_lnor. */
/**
* Reference vector, orthogonal to #vec_lnor, aligned with one of the edges (borders) of the
* smooth fan, called 'reference edge'.
*/
float vec_ref[3];
/** Third vector, orthogonal to vec_lnor and vec_ref. */
/** Third vector, orthogonal to #vec_lnor and #vec_ref. */
float vec_ortho[3];
/** Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
/**
* Reference angle around #vec_ortho, in ]0, pi] range, between #vec_lnor and the reference edge.
*
* A 0.0 value marks that space as invalid, as it can only happen in extremely degenerate
* geometry cases (it would mean that the default normal is perfectly aligned with the reference
* edge).
*/
float ref_alpha;
/** Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
/**
* Reference angle around #vec_lnor, in ]0, 2pi] range, between the reference edge and the other
* border edge of the fan.
*
* A 0.0 value marks that space as invalid, as it can only happen in degenerate geometry cases
* (it would mean that all the edges connected to that corner of the smooth fan are perfectly
* aligned).
*/
float ref_beta;
/** All loops using this lnor space (i.e. smooth fan of loops),
* as (depending on owning MLoopNorSpaceArrary.data_type):

22
source/blender/blenkernel/BKE_mesh.hh
View File

@@ -119,13 +119,29 @@ void normals_calc_verts(Span<float3> vert_positions,
struct CornerNormalSpace {
/** The automatically computed face corner normal, not including influence of custom normals. */
float3 vec_lnor;
/** Reference vector, orthogonal to #vec_lnor. */
/**
* Reference vector, orthogonal to #vec_lnor, aligned with one of the edges (borders) of the
* smooth fan, called 'reference edge'.
*/
float3 vec_ref;
/** Third vector, orthogonal to #vec_lnor and #vec_ref. */
float3 vec_ortho;
/** Reference angle around #vec_ortho, in [0, pi] range (0.0 marks space as invalid). */
/**
* Reference angle around #vec_ortho, in ]0, pi] range, between #vec_lnor and the reference edge.
*
* A 0.0 value marks that space as invalid, as it can only happen in extremely degenerate
* geometry cases (it would mean that the default normal is perfectly aligned with the reference
* edge).
*/
float ref_alpha;
/** Reference angle around #vec_lnor, in [0, 2pi] range (0.0 marks space as invalid). */
/**
* Reference angle around #vec_lnor, in ]0, 2pi] range, between the reference edge and the other
* border edge of the fan.
*
* A 0.0 value marks that space as invalid, as it can only happen in degenerate geometry cases
* (it would mean that all the edges connected to that corner of the smooth fan are perfectly
* aligned).
*/
float ref_beta;
};