Migrated source code from Simantics SVN

[simantics/platform.git] / bundles / org.simantics.scenegraph / src / org / simantics / scenegraph / utils / variable / DynamicObject.java

diff --git a/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/utils/variable/DynamicObject.java b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/utils/variable/DynamicObject.java
new file mode 100644 (file)
index 0000000..c60d1af
--- /dev/null
+++ b/bundles/org.simantics.scenegraph/src/org/simantics/scenegraph/utils/variable/DynamicObject.java
@@ -0,0 +1,60 @@
+/*******************************************************************************\r
+ * Copyright (c) 2007, 2010 Association for Decentralized Information Management\r
+ * in Industry THTH ry.\r
+ * All rights reserved. This program and the accompanying materials\r
+ * are made available under the terms of the Eclipse Public License v1.0\r
+ * which accompanies this distribution, and is available at\r
+ * http://www.eclipse.org/legal/epl-v10.html\r
+ *\r
+ * Contributors:\r
+ *     VTT Technical Research Centre of Finland - initial API and implementation\r
+ *******************************************************************************/\r
+package org.simantics.scenegraph.utils.variable;\r
+\r
+/**\r
+ * A container for a single dynamic-enabled float variable of a scene graph\r
+ * node. Dynamic-enabled means a variable that potentially has two values: one\r
+ * static (~ default) and one dynamic. If the dynamic part has a non-null value\r
+ * it should always be used instead of the static value. Use\r
+ * {@link #getActiveValue()} to get the current variable value to follow this\r
+ * policy in your client code.\r
+ * \r
+ * <p>\r
+ * Variables generally determine the way a node gets rendered.\r
+ * \r
+ * @author Tuukka Lehtonen\r
+ */\r
+public class DynamicObject<T> extends DynamicVariable<T> {\r
+\r
+    private T value;\r
+\r
+    public static <T> DynamicObject<T> make(T initialValue) {\r
+        return new DynamicObject<T>(initialValue);\r
+    }\r
+\r
+    public DynamicObject(T initialValue) {\r
+        this.value = initialValue;\r
+    }\r
+\r
+    public T getValue() {\r
+        return value;\r
+    }\r
+\r
+    public T getActiveValue() {\r
+        return dynamicValue != null ? dynamicValue : value;\r
+    }\r
+\r
+    /**\r
+     * Sets the static value of the variable.\r
+     * \r
+     * @param value new static value\r
+     */\r
+    public void setValue(T value) {\r
+        this.value = value;\r
+    }\r
+\r
+    public boolean hasDynamicValue() {\r
+        return dynamicValue != null && getValue() != getActiveValue();\r
+    }\r
+\r
+}\r