Insert Custom Input

 

Invoked ByInsert go to History Operation go to Custom Input (Part Level)

 

This command gathers user input based on a command template associated with this operation.  It then inserts it into the active part's history.  The template is defined during this command using the Command Template Editor.  

 

It is expected that the data gathered by this operation will be used to parametrically drive subsequent operations that make up a Custom Feature.  Custom features in turn can be copied to the 3D clipboard, saved and then (if they are self-contained) pasted into any active part.  You can create a library of custom features designed to fit your needs.

 

Tell Me More about this Command

 

As soon as this command is executed, the Command Template Editor is displayed.  Use it to create (or import) a command template.  Refer to the OpenVX Online Documentation for more about how VX uses template files.  Also refer to the Tips & Techniques section below.

 

When you pick OK from the editor, the template is compiled  and then executed.  You are then prompted for the Custom Input values similar to any other VX command.  Once you insert the operation, you can then proceed to create the operations that will be driven by the Custom Input.

 

 

Show Me the Basic Steps

 

  1. Use the Command Template Editor to create the command template.  An example template is shown below.

 
 

Command Template Editor
 

 

  1. Pick OK from the Command Template Editor and the template will be compiled and executed.
     

  2. The Custom Input prompts begin automatically.  Select entities or enter the values required for each prompt in your template.  The Command Options Form for the Custom Input in Step 1 is shown below.

 

 

Command Options Form for the Custom Input template

Command Options Form for Custom Input Operation

Custom Input Operation in the History Manager

The Custom Input Operation is Logged into the Active Part's History

 

 

  1. When you complete the last input or pick OK, the Custom Input operation is logged to active part's history.  Refer to the example above.

 

It's important to understand that no geometry has been created yet.  The Custom Input operation only gathers the input that you will use to drive additional operations.  The Custom Input operation and these additional operations will be used to define the Custom Feature.

 

 

Applying VXHow Operations are Derived from Custom Input

Tips & Techniques

 

Tips & TechniquesUsing template files for Custom Input operations

The file containing a Custom Input template must be named the same as the template with the ".t" extension appended to it.  If not, VX will not find the template when it needs to re-evaluate any operations defined by the template.  The template file must reside in one of the default directories searched by VX (i.e., those listed in the VX Search Path Form), or it must be embedded in the custom feature's parent part.  Refer to the Link Manager for embedding files into a part.

 

 

Tips & Techniques

How to indirectly reference Custom Input data

Input data from one history operation can be instanced by a subsequent operation by entering:

 

<history_operation_name,input_field_id>

 

at the command line prompt for entity, point, string, option or numeric input.  This identifies a given input data field of a given history operation.  The input from the referenced field is associatively copied to the active input field.  Any existing input is replaced.  

 

Input data indirectly referenced from another operation is re-evaluated during history regeneration.   This is a useful way to define a sequence of history operations based on inputs gathered with a single Custom Input operation.   It is a tool for constructing custom features.

 

 

Tips & TechniquesInquiring the ID number of a Custom Input field

Right-click on the name of the Custom Input operation in the History Manager and the select Inquire.  Information about the operation is displayed (below left).   Left-click the "parametric definition" field in the information window.  This will display a list of numbered input fields (below right).  The number is the id used to reference the corresponding input.

 

Inquiring Custom Input Field ID Numbers

Inquiring Custom Input Field ID Numbers

 

 

Related Topics

Return to VX CAD/CAM Index