CommandInputs.addFloatSpinnerCommandInput Method

Parent Object: CommandInputs
Defined in namespace "adsk::core" and the header file is <Core/UserInterface/CommandInputs.h>

Description

Adds a new spinner input to the command. The value type is float.

Syntax

Python
C++

"commandInputs_var" is a variable referencing a CommandInputs object.returnValue = commandInputs_var.addFloatSpinnerCommandInput(id, name, unitType, min, max, spinStep, initialValue)

"commandInputs_var" is a variable referencing a CommandInputs object.

#include <Core/UserInterface/CommandInputs.h>

returnValue = commandInputs_var->addFloatSpinnerCommandInput(id, name, unitType, min, max, spinStep, initialValue);

Return Value

Type	Description
FloatSpinnerCommandInput	Returns the created FloatSpinnerCommandInput object or null if the creation failed.

Parameters

Name	Type	Description
id	string	The unique ID of this command input. It must be unique with respect to the other inputs associated with this command.
name	string	The displayed name of this command as seen in the dialog.
unitType	string	The unit type of the value. This will be used to validate the input and the returned Value object will be of this type.
min	double	Provides the minimum value in database units.
max	double	Provides the maximum value in database units.
spinStep	double	Sets the spin step value in the unit type set by the unitType argument. The value should be more than zero. This is the amount the slider will advance when the user clicks the spin button beside the value.
initialValue	double	The initial value of this input as shown in the dialog. This value is assumed to be in database units for the specified unit type

Samples

Command Inputs API Sample

Creates a command dialog that demonstrates all of the available command inputs.

To use the sample, create a new Python or C++ script and copy and paste this code, replacing the default code. You also need to unpack this zip file which contains a resource folder into the same folder where the source code file (.py or .cpp) is.

Version

Introduced in version July 2015