gazebosim/sdformat

Document frame in sdf::Plane::Normal()

Open

#186 opened on May 2, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (122 forks)auto 404
1.5enhancementgood first issuemajor

Repository metrics

Stars
 (216 stars)
PR merge metrics
 (PR metrics pending)

Description

Original report (archived issue) by Alejandro Castro (Bitbucket: amcastro0622).

In what frame is the normal specified? is the frame of the / to which the geometry belongs? (ideal) or is that the model frame? (non-ideal).

Contributor guide

Research direction
Investigate the SDFormat specification to confirm that the normal is specified in the frame of the parent <visual> or <collision> element. Then update the documentation for sdf::Plane::Normal() to clarify this.
Tech stack
cpp
Domain
documentationapibackend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Needs investigation
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85