Skip to content

Triangulation_2 : Document the Triangulation_2_projection_traits_3 class#5407

Merged
sloriot merged 32 commits intoCGAL:masterfrom
maxGimeno:T2-Document_projection_traits_3-maxGimeno
Aug 31, 2021
Merged

Triangulation_2 : Document the Triangulation_2_projection_traits_3 class#5407
sloriot merged 32 commits intoCGAL:masterfrom
maxGimeno:T2-Document_projection_traits_3-maxGimeno

Conversation

@maxGimeno
Copy link
Contributor

@maxGimeno maxGimeno commented Jan 28, 2021

Summary of Changes

Add doc to the class T2_projection_traits_3.

TODO:

  • add an example
  • handle retro compatibility

Release Management

@maxGimeno maxGimeno added this to the 5.3-beta milestone Jan 28, 2021
@maxGimeno maxGimeno requested a review from sloriot January 28, 2021 13:57
@MaelRL MaelRL added Not yet approved The feature or pull-request has not yet been approved. Small feature labels Jan 29, 2021
@maxGimeno maxGimeno removed the TODO label Jan 29, 2021
@maxGimeno
Copy link
Contributor Author

/build:v1

@github-actions
Copy link

The documentation is built. It will be available, after a few minutes, here : https://cgal.github.io/5407/v1/Manual/index.html

@afabri
Copy link
Member

afabri commented Feb 17, 2021

@maxGimeno can you please make the changes and build the documentation again.

Also, unless I missed that a reviewer has spotted it as well, Project_to_plan is wrong. It should be Project_to_plane, but maybe even that is wrong as we have the concept ConstructProjectedPoint_3.

@sloriot @MaelRL any opinion on the name?

@maxGimeno maxGimeno force-pushed the T2-Document_projection_traits_3-maxGimeno branch from fc02465 to 1f5a847 Compare February 17, 2021 11:36
@maxGimeno
Copy link
Contributor Author

/build:v2

@github-actions
Copy link

The documentation is built. It will be available, after a few minutes, here : https://cgal.github.io/5407/v2/Manual/index.html

@sloriot
Copy link
Member

sloriot commented Feb 17, 2021

I don't think it needs to be documented.

@afabri
Copy link
Member

afabri commented Feb 17, 2021

I don't think it needs to be documented.

Just to be sure that I understand you right: There is no need to document it, as none of the 2D triangulation classes will ever call it, as there is no need for it to project points directly?

@sloriot
Copy link
Member

sloriot commented Feb 17, 2021

it is not used and there is actually no plane since only a normal is requested.

@afabri
Copy link
Member

afabri commented Feb 18, 2021

/build:v3

@github-actions
Copy link

The documentation is built. It will be available, after a few minutes, here : https://cgal.github.io/5407/v3/Manual/index.html

@afabri
Copy link
Member

afabri commented Feb 18, 2021

I do not understand why it is in the triangulation package and not just in the Kernel as the other projection traits classes.

@sloriot
Copy link
Member

sloriot commented Feb 19, 2021

Projection traits are models of PolygonTraits_2, ConvexHullTraits_2, TriangulationTraits_2, DelaunayTriangulationTraits_2, ConstrainedTriangulationTraits_2, ConvexHullTraits_2 and DelaunayMeshTraits_2. If this class is only model of triangulation concepts it makes sense to be here. If it is model of more then it can be moved in kernel, renamed + headers and template alias added for backward compatibility.

@sloriot
Copy link
Member

sloriot commented Aug 26, 2021

Tests failing. For example here

@sloriot
Copy link
Member

sloriot commented Aug 26, 2021

Example name conflicting with Weights/examples/Weights/projection_traits.cpp

@sloriot sloriot added Under Testing pre-approved For pre-approved small features. After 15 days the feature will be accepted. and removed Not yet approved The feature or pull-request has not yet been approved. labels Aug 26, 2021
@maxGimeno
Copy link
Contributor Author

@sloriot sloriot merged commit 6e4f55e into CGAL:master Aug 31, 2021
@sloriot sloriot deleted the T2-Document_projection_traits_3-maxGimeno branch August 31, 2021 17:01
@MaelRL MaelRL added Accepted small feature and removed pre-approved For pre-approved small features. After 15 days the feature will be accepted. labels Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document Triangulation_2_projection_traits_3

6 participants