Changeset 5646 for trunk

Timestamp:

May 31, 2015, 6:59:12 PM (9 years ago)

Author:

ldelgass

Message:

Add info to comments

File:

• trunk/gui/scripts/field.tcl (modified) (2 diffs)

trunk/gui/scripts/field.tcl

@@ -385 +385 @@
 #
 # Returns a list {min max} representing the limits for the specified
-# axis.
+# axis over all components.
 # ----------------------------------------------------------------------
 itcl::body Rappture::Field::limits {which} {
@@ -503 +503 @@
 # USAGE: fieldlimits
 #
-# Returns a list {min max} representing the limits for the specified
-# axis.
+# This method is for use with VTK components that have multiple fields.
+# It really makes no sense to have multiple fields in a field, but this
+# is here until we add a proper dataset object to hold multiple fields.
+#
+# Returns an array mapping fieldname => list {min max} representing the
+# limits over all components for the given fieldname.  This assumes that
+# all components have the same set of fields.
 # ----------------------------------------------------------------------
 itcl::body Rappture::Field::fieldlimits {} {