1 
2 //
3 // This source file is part of appleseed.
4 // Visit https://appleseedhq.net/ for additional information and resources.
5 //
6 // This software is released under the MIT license.
7 //
8 // Copyright (c) 2010-2013 Francois Beaune, Jupiter Jazz Limited
9 // Copyright (c) 2014-2018 Francois Beaune, The appleseedhq Organization
10 //
11 // Permission is hereby granted, free of charge, to any person obtaining a copy
12 // of this software and associated documentation files (the "Software"), to deal
13 // in the Software without restriction, including without limitation the rights
14 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 // copies of the Software, and to permit persons to whom the Software is
16 // furnished to do so, subject to the following conditions:
17 //
18 // The above copyright notice and this permission notice shall be included in
19 // all copies or substantial portions of the Software.
20 //
21 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 // THE SOFTWARE.
28 //
29 
30 #pragma once
31 
32 // appleseed.renderer headers.
33 #include "renderer/modeling/entity/entitytraits.h"
34 #include "renderer/modeling/environmentshader/environmentshader.h"
35 #include "renderer/modeling/scene/containers.h"
36 
37 // appleseed.foundation headers.
38 #include "foundation/utility/autoreleaseptr.h"
39 #include "foundation/utility/containers/dictionary.h"
40 
41 // Forward declarations.
42 namespace renderer  { class EnvironmentShaderFactoryRegistrar; }
43 
44 namespace renderer
45 {
46 
47 //
48 // Environment shader entity traits.
49 //
50 
51 template <>
52 struct EntityTraits<EnvironmentShader>
53 {
54     typedef EnvironmentShaderContainer ContainerType;
55     typedef EnvironmentShaderFactoryRegistrar FactoryRegistrarType;
56 
57     static const char* get_entity_type_name()                           { return "environment_shader"; }
58     static const char* get_human_readable_entity_type_name()            { return "Environment Shader"; }
59     static const char* get_human_readable_collection_type_name()        { return "Environment Shaders"; }
60 
61     template <typename ParentEntity>
62     static ContainerType& get_entity_container(ParentEntity& parent)    { return parent.environment_shaders(); }
63 
64     static foundation::Dictionary get_entity_values(const EnvironmentShader* entity)
65     {
66         return entity->get_parameters();
67     }
68 
69     template <typename ParentEntity>
70     static void insert_entity(
71         foundation::auto_release_ptr<EnvironmentShader> entity,
72         ParentEntity&                                   parent)
73     {
74         get_entity_container(parent).insert(entity);
75     }
76 
77     template <typename ParentEntity>
78     static void remove_entity(
79         EnvironmentShader*                              entity,
80         ParentEntity&                                   parent)
81     {
82         get_entity_container(parent).remove(entity);
83     }
84 };
85 
86 }   // namespace renderer
87