Skip to content

Commit

Permalink
Merge pull request #755 from est77/est_lights_metadata_docs
Browse files Browse the repository at this point in the history 
Added metadata docs for light entities
  • Loading branch information
@est77
est77 committed May 28, 2015
2 parents e92914e + 0d9c2cc commit 31b61ff
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 18 deletions.
9 changes: 6 additions & 3 deletions src/appleseed/renderer/modeling/light/directionallight.cpp
View file
Expand Up @@ -254,7 +254,8 @@ Dictionary DirectionalLightFactory::get_model_metadata() const
return
Dictionary()
.insert("name", Model)
.insert("label", "Directional Light");
.insert("label", "Directional Light")
.insert("help", "A light source that emits light in a single direction");
}

DictionaryArray DirectionalLightFactory::get_input_metadata() const
Expand All @@ -270,7 +271,8 @@ DictionaryArray DirectionalLightFactory::get_input_metadata() const
Dictionary()
.insert("color", "Colors"))
.insert("use", "required")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity"));

metadata.push_back(
Dictionary()
Expand All @@ -280,7 +282,8 @@ DictionaryArray DirectionalLightFactory::get_input_metadata() const
.insert("min_value", "0.0")
.insert("max_value", "10.0")
.insert("use", "optional")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity multiplier"));

add_common_input_metadata(metadata);

Expand Down
6 changes: 4 additions & 2 deletions src/appleseed/renderer/modeling/light/ilightfactory.cpp
View file
Expand Up @@ -47,15 +47,17 @@ void ILightFactory::add_common_input_metadata(DictionaryArray& metadata)
.insert("label", "Cast Indirect Light")
.insert("type", "boolean")
.insert("use", "optional")
.insert("default", "true"));
.insert("default", "true")
.insert("help", "If enabled, this light contributes to indirect lighting"));

metadata.push_back(
Dictionary()
.insert("name", "importance_multiplier")
.insert("label", "Importance Multiplier")
.insert("type", "text")
.insert("use", "optional")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Adjust the sampling effort for this light with respect to the other lights"));
}

} // namespace renderer
9 changes: 6 additions & 3 deletions src/appleseed/renderer/modeling/light/pointlight.cpp
View file
Expand Up @@ -165,7 +165,8 @@ Dictionary PointLightFactory::get_model_metadata() const
Dictionary()
.insert("name", Model)
.insert("label", "Point Light")
.insert("default_model", "true");
.insert("default_model", "true")
.insert("help", "A light source that emits light equally in all directions from a point");
}

DictionaryArray PointLightFactory::get_input_metadata() const
Expand All @@ -181,7 +182,8 @@ DictionaryArray PointLightFactory::get_input_metadata() const
Dictionary()
.insert("color", "Colors"))
.insert("use", "required")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity"));

metadata.push_back(
Dictionary()
Expand All @@ -191,7 +193,8 @@ DictionaryArray PointLightFactory::get_input_metadata() const
.insert("min_value", "0.0")
.insert("max_value", "10.0")
.insert("use", "optional")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity multiplier"));

add_common_input_metadata(metadata);

Expand Down
18 changes: 12 additions & 6 deletions src/appleseed/renderer/modeling/light/spotlight.cpp
View file
Expand Up @@ -229,7 +229,8 @@ Dictionary SpotLightFactory::get_model_metadata() const
return
Dictionary()
.insert("name", Model)
.insert("label", "Spot Light");
.insert("label", "Spot Light")
.insert("help", "A light source that emits light in a cone of directions from a point");
}

DictionaryArray SpotLightFactory::get_input_metadata() const
Expand All @@ -246,7 +247,8 @@ DictionaryArray SpotLightFactory::get_input_metadata() const
.insert("color", "Colors")
.insert("texture_instance", "Textures"))
.insert("use", "required")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity"));

metadata.push_back(
Dictionary()
Expand All @@ -256,7 +258,8 @@ DictionaryArray SpotLightFactory::get_input_metadata() const
.insert("entity_types",
Dictionary().insert("texture_instance", "Textures"))
.insert("use", "optional")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity multiplier"));

metadata.push_back(
Dictionary()
Expand All @@ -266,7 +269,8 @@ DictionaryArray SpotLightFactory::get_input_metadata() const
.insert("min_value", "-180.0")
.insert("max_value", "180.0")
.insert("use", "required")
.insert("default", "20.0"));
.insert("default", "20.0")
.insert("help", "Cone distribution inner angle"));

metadata.push_back(
Dictionary()
Expand All @@ -276,7 +280,8 @@ DictionaryArray SpotLightFactory::get_input_metadata() const
.insert("min_value", "-180.0")
.insert("max_value", "180.0")
.insert("use", "required")
.insert("default", "30.0"));
.insert("default", "30.0")
.insert("help", "Cone distribution outer angle"));

metadata.push_back(
Dictionary()
Expand All @@ -286,7 +291,8 @@ DictionaryArray SpotLightFactory::get_input_metadata() const
.insert("min_value", "-360.0")
.insert("max_value", "360.0")
.insert("use", "optional")
.insert("default", "0.0"));
.insert("default", "0.0")
.insert("help", "Rotate the spot light around its axis; only useful when using the light intensity is textured (gobo)"));

add_common_input_metadata(metadata);

Expand Down
12 changes: 8 additions & 4 deletions src/appleseed/renderer/modeling/light/sunlight.cpp
View file
Expand Up @@ -445,7 +445,8 @@ Dictionary SunLightFactory::get_model_metadata() const
return
Dictionary()
.insert("name", Model)
.insert("label", "Sun Light");
.insert("label", "Sun Light")
.insert("help", "Physically-based sun light");
}

DictionaryArray SunLightFactory::get_input_metadata() const
Expand All @@ -459,7 +460,8 @@ DictionaryArray SunLightFactory::get_input_metadata() const
.insert("type", "entity")
.insert("entity_types",
Dictionary().insert("environment_edf", "Environment EDFs"))
.insert("use", "optional"));
.insert("use", "optional")
.insert("help", "If an environment EDF is bound, use the sun angles and turbidity values from the environment"));

metadata.push_back(
Dictionary()
Expand All @@ -469,7 +471,8 @@ DictionaryArray SunLightFactory::get_input_metadata() const
.insert("entity_types",
Dictionary().insert("texture_instance", "Textures"))
.insert("use", "required")
.insert("default", "4.0"));
.insert("default", "4.0")
.insert("help", "Atmospheric haziness"));

metadata.push_back(
Dictionary()
Expand All @@ -479,7 +482,8 @@ DictionaryArray SunLightFactory::get_input_metadata() const
.insert("min_value", "0.0")
.insert("max_value", "10.0")
.insert("use", "optional")
.insert("default", "1.0"));
.insert("default", "1.0")
.insert("help", "Light intensity multiplier"));

add_common_input_metadata(metadata);

Expand Down

0 comments on commit 31b61ff

Please sign in to comment.