Introduced
1.0
Description
Loads objects into a property editor. This allows a user to interactively view and edit the parameters of an object. You can use the siModal mode for the Mode parameter to communicate with the user (like a dialog box), as demonstrated in the first example below.
A property page can display several objects at the same time. If the objects are of different types then they will appear one after another. For example, when inspecting a Sphere, the X3DObject, Primitive and Operator are shown in this fashion. Alternatively, if the objects are of the same type then they are shown in "multi" mode. This mode is useful for changing a parameter on many objects at the same time. The examples below show both cases.
Normally when you inspect an object its nested objects will also be inspected within the same frame. You can limit which nested objects are inspected by using a list of keywords. For example, you can just display the Animation property set by specifying siAnimationKeyword in the Keywords parameter.
Scripting Syntax
InspectObj( [InputObjs], [Keywords], [Title], [Mode], [Throw] )
Parameters
|
Parameter |
Type |
Description |
|
InputObjs [in/out] |
List of objects to inspect. Default Value: Current selection. Note: if the selection contains more than one object then only the first appears. |
|
|
Keywords [in/out] |
Specify which property set appears for the specified object (eg., Animation, Hair, IK, Deform, etc.) Default Value: "" (clear current marking) |
|
|
Title |
Title of the property editor dialog. Note: the title you use here only appears on the property editor if you use siModal for the Mode parameter. Default Value: Generated from names of input objects. |
|
|
Mode |
Specifies whether the dialog should be locked, recycling, focused, or modal. Default Value: siRecycle |
|
|
Throw |
True to throw an error if the command is cancelled. Note: If this argument is set to false and the user cancels the command, the command returns true instead of throwing an error. Default Value: True |
Return Value
Returns true if the command was canceled and the Throw argument is set to false. If the command was canceled and the Throw argument was not specified (or is set to true) the command throws an error. Otherwise, it returns false.
See Also
Examples
• See InspectObj.1.vbs
• See InspectObj.2.vbs
• See InspectObj.3.vbs
• See InspectObj.4.vbs
• See InspectObj.5.vbs
• See InspectObj.6.js
• See InspectObj.7.js
Autodesk Softimage 2011