FloatProperty.getLimits Method

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

Description

Method that returns any limits for the value of this property. The HasLimits property can be used to see if there are any limits or not.

This is most commonly used for properties associated with materials and appearances.

Syntax

"floatProperty_var" is a variable referencing a FloatProperty object.

(returnValue, hasLowLimit, lowLimit, hasHighLimit, highLimit) = floatProperty_var.getLimits()
 

#include <Core/Application/FloatProperty.h

// Declare the output arguments.
boolean hasLowLimit;
double lowLimit;
boolean hasHighLimit;
double highLimit;
boolean returnValue = floatProperty_var->getLimits(hasLowLimit, lowLimit, hasHighLimit, highLimit);

Return Value

Type Description
boolean Returns true if the method call was successful.

Parameters

Name Type Description
hasLowLimit boolean Output Boolean that indicates if there is a low limit or not.
lowLimit double If the hasLowLimit argument is true, this argument returns the low limit.
hasHighLimit boolean Output Boolean that indicates if there is a high limit or not.
highLimit double If the hasHighLimit argument is true, this argument returns the high limit.

Version

Introduced in version August 2014