api-issue-tracker icon indicating copy to clipboard operation
api-issue-tracker copied to clipboard

Missing Sketchup::Vertex Support in View#screen_coords Documentation

Open son-urban opened this issue 9 months ago • 0 comments

Summary The documentation for View#screen_coords states that it accepts a Geom::Point3d as the model_point parameter. However, in testing, the method also accepts a Sketchup::Vertex object, which is not documented.

Steps to Reproduce

view = Sketchup.active_model.active_view
entities = Sketchup.active_model.entities
edge = entities.add_edges([0,0,0], [10,10,10])
vertex = edge.first.start

screen_position = view.screen_coords(vertex)
puts screen_position 

-> (3.394118 m, 5.658117 m, 0.011973 m) 
# This works but is not documented

Expected Behavior If Sketchup::Vertex is a valid argument, the documentation should mention it explicitly.

Actual Behavior The documentation only lists Geom::Point3d as the accepted parameter type, which may lead developers to believe that passing a Sketchup::Vertex is invalid.

Suggested Fix Update the parameter description in the documentation to include Sketchup::Vertex as an accepted type:

model_point (Geom::Point3d), Sketchup::Vertex This would clarify that Sketchup::Vertex is also a valid input, improving accuracy and usability for developers.

son-urban avatar Mar 21 '25 15:03 son-urban