1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
// K-3D
// Copyright (c) 1995-2006, Timothy M. Shead
//
// Contact: tshead@k-3d.com
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU General Public
// License as published by the Free Software Foundation; either
// version 2 of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public
// License along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
/** \file
\author Timothy M. Shead (tshead@k-3d.com)
*/
#include <boost/python.hpp>
#include <k3dsdk/python/any_python.h>
#include <k3dsdk/python/iproperty_python.h>
#include <k3dsdk/python/iunknown_python.h>
#include <k3dsdk/python/utility_python.h>
#include <k3dsdk/idocument.h>
#include <k3dsdk/ienumeration_property.h>
#include <k3dsdk/inode.h>
#include <k3dsdk/imeasurement_property.h>
#include <k3dsdk/iwritable_property.h>
#include <k3dsdk/measurement.h>
#include <k3dsdk/property.h>
#include <k3dsdk/type_registry.h>
using namespace boost::python;
namespace k3d
{
namespace python
{
static const string_t name(iunknown_wrapper& Self)
{
return Self.wrapped<k3d::iproperty>().property_name();
}
static const string_t label(iunknown_wrapper& Self)
{
return Self.wrapped<k3d::iproperty>().property_label();
}
static const string_t description(iunknown_wrapper& Self)
{
return Self.wrapped<k3d::iproperty>().property_description();
}
static const string_t type(iunknown_wrapper& Self)
{
return k3d::type_string(Self.wrapped<k3d::iproperty>().property_type());
}
static object internal_value(iunknown_wrapper& Self)
{
return any_to_python(k3d::property::internal_value(Self.wrapped<k3d::iproperty>()));
}
static object pipeline_value(iunknown_wrapper& Self)
{
return any_to_python(k3d::property::pipeline_value(Self.wrapped<k3d::iproperty>()));
}
static object node(iunknown_wrapper& Self)
{
return any_to_python(Self.wrapped<k3d::iproperty>().property_node());
}
static const bool is_writable(iunknown_wrapper& Self)
{
return Self.wrapped_ptr<k3d::iwritable_property>() ? true : false;
}
static void set_value(iunknown_wrapper& Self, const boost::python::object& Value)
{
if(k3d::iwritable_property* const writable = Self.wrapped_ptr<k3d::iwritable_property>())
{
writable->property_set_value(python_to_any(Value, Self.wrapped<k3d::iproperty>().property_type()));
return;
}
throw std::runtime_error("property " + Self.wrapped<k3d::iproperty>().property_name() + " is a read-only property");
}
static const bool is_enumeration(iunknown_wrapper& Self)
{
return Self.wrapped_ptr<k3d::ienumeration_property>() ? true : false;
}
static list enumeration_values(iunknown_wrapper& Self)
{
list results;
if(k3d::ienumeration_property* const enumeration = Self.wrapped_ptr<k3d::ienumeration_property>())
{
const k3d::ienumeration_property::enumeration_values_t values = enumeration->enumeration_values();
for(k3d::ienumeration_property::enumeration_values_t::const_iterator value = values.begin(); value != values.end(); ++value)
results.append(value->value);
}
return results;
}
static const string_t units(iunknown_wrapper& Self)
{
if(k3d::imeasurement_property* const measurement = Self.wrapped_ptr<k3d::imeasurement_property>())
{
const std::type_info& units = measurement->property_units();
if(units == typeid(void))
return "scalar";
if(units == typeid(k3d::measurement::angle))
return "angle";
if(units == typeid(k3d::measurement::area))
return "area";
if(units == typeid(k3d::measurement::distance))
return "distance";
if(units == typeid(k3d::measurement::force))
return "force";
if(units == typeid(k3d::measurement::mass))
return "mass";
if(units == typeid(k3d::measurement::pressure))
return "pressure";
if(units == typeid(k3d::measurement::time))
return "time";
if(units == typeid(k3d::measurement::volume))
return "volume";
return "unknown";
}
return "";
}
void define_methods_iproperty(iunknown& Interface, boost::python::object& Instance)
{
if(!dynamic_cast<iproperty*>(&Interface))
return;
utility::add_method(utility::make_function(&name, "Unique identifier, used for serialization and scripting."), "name", Instance);
utility::add_method(utility::make_function(&label, "Localized, human-readable text that labels the property in the user interface."), "label", Instance);
utility::add_method(utility::make_function(&description, "Localized, human-readable description of the property."), "description", Instance);
utility::add_method(utility::make_function(&type, "Returns the type of data the property stores as a string."), "type", Instance);
utility::add_method(utility::make_function(&internal_value, "Returns the value stored by the property."), "internal_value", Instance);
utility::add_method(utility::make_function(&pipeline_value, "Returns the property's 'pipeline' value, which will differ from its internal value if it's connected to another property by the Visualization Pipeline."), "pipeline_value", Instance);
utility::add_method(utility::make_function(&node, "Returns the node (if any) that owns the property, or None."), "node", Instance);
utility::add_method(utility::make_function(&is_writable, "Returns true if the property's internal value can be modified."), "is_writable", Instance);
utility::add_method(utility::make_function(&set_value, "Sets the property's internal value."), "set_value", Instance);
utility::add_method(utility::make_function(&is_enumeration, "Returns true if the property datatype is an enumeration."), "is_enumeration", Instance);
utility::add_method(utility::make_function(&enumeration_values, "Returns a list containing the set of allowable property values, if the property is an enumeration."), "enumeration_value", Instance);
utility::add_method(utility::make_function(&units, "Returns a string describing the real-world unit-of-measure stored by the property, if any."), "units", Instance);
}
} // namespace python
} // namespace k3d
|
