class = "entity"
This class is used to interactively get an entity pick or a list of entity picks.
Use VxInpEnt(), VxInpPath() or VxInpOh() to retrieve data items of the "entity" class from a VDATA object.
|
"dbl_pick_ok" |
Allow an entity to be picked twice during execution of a single template |
|
"qpick_on" |
Enable dynamic highlighting of entities as the locator passes over them. |
|
"qpick_off" |
Disable dynamic highlighting of entities. |
|
/<entity class>/<entity class>/..../ |
(see documentation for "point" class) |
|
"limit=<count>" |
If "list=yes", limit the number of entity picks to <count>. |
|
"string=<text>" |
Initialize the text input field with <text>. |
|
"pause_id=<form_id>" |
Set the id of the form that, when executed, will cause the active form to be paused automatically. |
|
"cmd=<template name>" |
Set the name of the template to execute if the active field is accepted without input. For example, when a command prompts the user to select a profile, this option may be used to automatically invoke the "create profile" command if the user presses the middle mouse button or <Enter> without selecting a profile (e.g. extrusion command). |
|
"pick_par" |
Start pick traversal with target object's parent, excluding the target object from traversal. By default, the scope of entity pick traversal is limited to the target object. |
|
"def_ent" |
Use the "default entity". If there is not a "default entity", save this field's entity pick as the "default entity". The "default" entity is cleared each time a new command is executed (but not when a command is auto-repeated).
When a command function is driven by an auto-repeating template using this option, it should call "void InFormEscape(void)" to start a new command when no data in the template is defined except the default entity.
For example, if the first field of an auto-repeating template is used to select a curve with the "def_ent" option, and the second field is used to select another entity without the "def_ent" option, if the user accepts the second field without picking an entity, it means he wants to escape the form (like pressing the middle mouse button while selecting a list of entities), so the command function should call InFormEscape() to terminate auto-repetition of the form if the second field is empty. |
|
"chk_line" |
Only accept linear entity picks. |
|
"chk_plane" |
Only accept planar entity picks. |
|
"empty_ok" |
Accept field when the middle mouse button or <Enter> is pressed, even if the field is empty (i.e. doesn't have input data). |
|
"form=<name>" |
Display the specified GUI form while the entity input widget is active. Un-display the form when the widget is de-activated. |
|
"pop_up=<name>" |
Display the specified pop-up menu while the entity input widget is active (if the right mouse button is pressed). |
|
"show=<gui form name>" |
Display the specified GUI form. The form will be taken down automatically when a new command is executed (it stays up while a command is repeated). |
|
"~<function name>" |
Calls the specified C function, which is assumed to be of type "void function(void)". |
|
"browse = <object class id>" |
Activates the pop-up menu with the Browse input option. When the user selects the "Browse" option, a list of objects of the specified class will be displayed. Set "object class id" to -1 to display objects of all classes.
For now, this option may only be used to display root objects when a file is active, but no target object is active. |
|
"hi_depth = <depth>" |
Sets the depth of assembly traversal for highlighting. "hi_depth = 1" will only traverse through the top-level part. "hi_depth > 1" will traverse into sub-parts. |
|
"root_path" |
Force pick-path to record beginning with the "root-most" object. |
|
"frozen_ok" |
Allow "frozen" entities to be picked. |
|
"pick_comp" or "ignore_comp" |
Make the active component (int VgCompIndex) the only component in the target object that can be picked (pick_comp) or the only component that cannot be picked (ignore_comp). |
|
"ignore_targ" |
Exclude target object from pick traversal. |
|
"tpl_name = string" |
Limits picks to entities that were created with a template of the given name. |
|
"chain_pick" |
Make chain picking the initial pick state. |
|
"assem_mode" |
Enable extended entity picking if assembly modeling mode is active. |
|
"extend" |
Allow extended entity picking when F8 is held down. |
|
"chk_dwgtbl" |
Only accept drawing table entity picks. |