Working on the Light Struct #2
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
elpiel
requested changes
Oct 2, 2021
Member
There was a problem hiding this comment.
Very good progress!
There are a few minor things and a couple of general I'm going to mention here:
- All structs should be renamed, since they all, by default, start with capital letters (it's a
serde/serde_xmlimpl detail) - All fields & structs must be
pub - I've realised that I've forgotten to add the default values as a documentation, so make sure to include this as well in the docs.
- Can you also add tests please?
You can add a raw string of xml deserialized into a struct which will also check for the default values. So the xml won't have the values set but you will expect them in the resulting deserialize struct.
| #[derive(Debug, Serialize, Deserialize)] | ||
| pub struct Light {} | ||
| pub struct Light { | ||
| // A unique name for the light |
Member
There was a problem hiding this comment.
- Please use doc comments
///so that the information shows in the documentation.
| pub struct Light { | ||
| // A unique name for the light | ||
| name: String, | ||
| // The light type: point, directional spot |
Member
There was a problem hiding this comment.
- there is a missing comma
point, directional, spot
| // A unique name for the light | ||
| name: String, | ||
| // The light type: point, directional spot | ||
| #[serde(default)] |
Member
There was a problem hiding this comment.
- The default should be set up using
serde. - Use an Enum since the available options are only 3
point,directional,spot
You might need to use https://crates.io/crates/parse-display for this. I'm not aware how Enums with no data are deserialized so you have to double-check this. - Make sure to rename the
light_typetotypewith anserdeattribute
| cast_shadows: Option<bool>, | ||
| // Scale factor to set the relative power of a light | ||
| #[serde(default)] | ||
| intensity: Option<f64>, |
Member
There was a problem hiding this comment.
- The default for this value is
1, right now withserde(default)it isNone.
Comment on lines
+199
to
+202
| diffuse: Option<Color>, | ||
| // Specular light color | ||
| #[serde(default)] | ||
| specular: Option<Color>, |
Member
There was a problem hiding this comment.
- Please add default functions that set the correct values for
diffuse(1 1 1 1) &specular(0.1 0.1 0.1 1). This could be achieved by adding associated functions toColorfor the default values, likeColor::specular_default()
| attenuation: Vec<Attenuation>, | ||
| // Direction of light, only applicable for spot and directional light | ||
| #[serde(default)] | ||
| direction: Vec<i32>, |
Member
There was a problem hiding this comment.
Vec3 actually means a mathematical vector.
You can use a tuple struct and eventually we might use something like nalgebra's structs but this is not required for the moment
https://docs.rs/nalgebra/0.29.0/nalgebra/base/type.Vector3.html
- Please add proper default.
Comment on lines
+218
to
+238
| pub struct Attenuation { | ||
| range: f64, | ||
| linear: Option<f64>, | ||
| constant: Option<f64>, | ||
| quadratic: Option<f64>, | ||
| } | ||
|
|
||
| // Spot light parameters | ||
| pub struct Spot { | ||
| inner_angle: f64, | ||
| outer_angle: f64, | ||
| falloff: f64, | ||
| } | ||
|
|
||
| // A position and orientation with respect to the frame named in relative_to attribute | ||
| pub struct Pose { | ||
| relative_to: Option<String>, | ||
| } | ||
|
|
||
| // Unit struct for tpe `color` | ||
| struct Color(u8, u8, u8); |
Member
There was a problem hiding this comment.
- structs are missing the documentation of the fields.
-
deriveDebug, Deser. & Ser.
|
|
||
| // A position and orientation with respect to the frame named in relative_to attribute | ||
| pub struct Pose { | ||
| relative_to: Option<String>, |
Member
There was a problem hiding this comment.
-
Posehas value as well
<pose relative_to="...">value</pose>
Member
|
I found an example of how to force attributes (will be done in future PRs though as it requires a lot of enums) and use an enum for #[derive(Debug, Serialize, Deserialize, PartialEq)]
enum PitchType { FourSeam, TwoSeam, Changeup, Cutter, Curve, Slider, Knuckle, Pitchout }You can see the documentation of serde_xml: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hey, @elpiel can you take a look at this PR and give comments on what needs improvement? The other two should be ready by the end of today.