Difference between revisions of "ServerManager XML Hints"

From KitwarePublic
Jump to: navigation, search
(Created page with "<font color="blue">NOTE: This is under development and may not cover all available hints</font> ===Mark proxy as a reader=== * Used to mark a proxy under the "sources" group as...")
 
Line 1: Line 1:
 
<font color="blue">NOTE: This is under development and may not cover all available hints</font>
 
<font color="blue">NOTE: This is under development and may not cover all available hints</font>
 +
==Proxy Hints==
 +
 +
These are hints added to proxies.
  
 
===Mark proxy as a reader===
 
===Mark proxy as a reader===
  
 
* Used to mark a proxy under the "sources" group as a reader.
 
* Used to mark a proxy under the "sources" group as a reader.
 
+
* ''extensions'' attribute is used to list the supported extensions e.g. "foo foo.bar" for files named as somename.foo or somename.foo.bar.
 +
* ''filename_patterns'' attribute is used to list the filename patterns to match. The format is similar to what one would use for "ls" using wildcards e.g. spcth* to match spcta, spctb etc.
 
<source lang="xml">
 
<source lang="xml">
 
  <Hints>
 
  <Hints>
   <ReaderFactory extensions="<space separated extensions w/o leading '.'>"
+
   <ReaderFactory extensions="[space separated extensions w/o leading '.']"
                   filename_patterns="<space separated filename patters (using wildcards)>"
+
                   filename_patterns="[space separated filename patters (using wildcards)]"
                   file_description="Meta Image Data Files" />
+
                   file_description="[user-friendly description]" />
 
  </Hints>
 
  </Hints>
 +
</source>
 +
 +
===Hide a property===
 +
 +
* Used to hide a property from the auto-generated Properties panel.
 +
<source lang="xml">
 +
  <Hints>
 +
    <Property name="[property name]" show="0" />
 +
  </Hints>
 +
</source>
 +
 +
==Property Hints==
 +
 +
These are hints added to Properties.
 +
 +
===Selection Input===
 +
 +
* If a filter needs to use the "active selection", one can use this hint.
 +
* Only used by auto-generated Properties panel.
 +
* Specified on a Input property that can take in a vtkSelection.
 +
 +
<source lang="xml">
 +
  <InputProperty name="Selection"
 +
      command="SetSelectionConnection">
 +
      <DataTypeDomain name="input_type">
 +
        <DataType value="vtkSelection"/>
 +
      </DataTypeDomain>
 +
      <Documentation>
 +
        The input that provides the selection object.
 +
      </Documentation>
 +
      <Hints>
 +
        <!-- This tag alerts the auto-generated panels and input selection
 +
              that this input is a selection.  It should use the special
 +
              selection GUI. -->
 +
        <SelectionInput />
 +
      </Hints>
 +
  </InputProperty>
 
</source>
 
</source>

Revision as of 11:50, 9 May 2011

NOTE: This is under development and may not cover all available hints

Proxy Hints

These are hints added to proxies.

Mark proxy as a reader

  • Used to mark a proxy under the "sources" group as a reader.
  • extensions attribute is used to list the supported extensions e.g. "foo foo.bar" for files named as somename.foo or somename.foo.bar.
  • filename_patterns attribute is used to list the filename patterns to match. The format is similar to what one would use for "ls" using wildcards e.g. spcth* to match spcta, spctb etc.
 <Hints>
   <ReaderFactory extensions="[space separated extensions w/o leading '.']"
                  filename_patterns="[space separated filename patters (using wildcards)]"
                  file_description="[user-friendly description]" />
 </Hints>

Hide a property

  • Used to hide a property from the auto-generated Properties panel.
  <Hints>
    <Property name="[property name]" show="0" />
  </Hints>

Property Hints

These are hints added to Properties.

Selection Input

  • If a filter needs to use the "active selection", one can use this hint.
  • Only used by auto-generated Properties panel.
  • Specified on a Input property that can take in a vtkSelection.
  <InputProperty name="Selection"
       command="SetSelectionConnection">
       <DataTypeDomain name="input_type">
         <DataType value="vtkSelection"/>
       </DataTypeDomain>
       <Documentation>
         The input that provides the selection object.
       </Documentation>
       <Hints>
         <!-- This tag alerts the auto-generated panels and input selection
              that this input is a selection.  It should use the special
              selection GUI. -->
         <SelectionInput />
       </Hints>
  </InputProperty>