HoleFeatures.createCounterboreInput Method

Parent Object: HoleFeatures
Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/HoleFeatures.h>

Description

Creates a HoleFeatureInput object that defines a counterbore hole. This is not a hole feature but an object used to create a hole feature. Functionality on the returned HoleFeatureInput object is used to define the position and extent of the hole.

Syntax

"holeFeatures_var" is a variable referencing a HoleFeatures object.
returnValue = holeFeatures_var.createCounterboreInput(holeDiameter, counterboreDiameter, counterboreDepth)
"holeFeatures_var" is a variable referencing a HoleFeatures object.

#include <Fusion/Features/HoleFeatures.h>

returnValue = holeFeatures_var->createCounterboreInput(holeDiameter, counterboreDiameter, counterboreDepth);

Return Value

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

Parameters

Name Type Description
holeDiameter ValueInput A ValueInput object that defines the diameter of the hole. If the ValueInput uses a real, it is interpreted as centimeters. If it is a string, the units can be defined as part of the string (i.e. "3 in") If no units are specified, it is interpreted using the current default units for length.
counterboreDiameter ValueInput A ValueInput object that defines the counterbore diameter of the hole. If the ValueInput uses a real, it is interpreted as centimeters. If it is a string, the units can be defined as part of the string (i.e. "3 in") If no units are specified, it is interpreted using the current default units for length.
counterboreDepth ValueInput A ValueInput object that defines the counterbore depth of the hole. If the ValueInput uses a real, it is interpreted as centimeters. If it is a string, the units can be defined as part of the string (i.e. "3 in") If no units are specified, it is interpreted using the current default units for length.

Samples

Name Description
holeFeatures.add with Counterbore Demonstrates the holeFeatures.add method using the createCounterboreInput method. The hole is positioned at the center of the selected edge.

Version

Introduced in version August 2014