HoleFeatureInput Object

Derived from: Base Object
Defined in namespace "adsk::fusion" and the header file is <Fusion/Features/HoleFeatureInput.h>

Description

This class defines the methods and properties that pertain to the definition of a hole feature.

Methods

Name Description
classType Static function that all classes support that returns the type of the class as a string. The returned string matches the string returned by the objectType property. For example if you have a reference to an object and you want to check if it's a SketchLine you can use myObject.objectType == fusion.SketchLine.classType().
setAllExtent Defines the extent of the hole to be through-all. The direction can be either positive, negative.
setDistanceExtent Defines the depth of the hole using a specified distance.
setOneSideToExtent Sets the extent of the hole to be from the sketch plane to the specified "to" face.
setPositionAtCenter Defines the position of the hole at the center of a circular or elliptical edge of the face.
setPositionByPlaneAndOffsets Defines the orientation of the hole using a planar face or construction plane. The position of the hole is defined by the distance from one or two edges.
setPositionByPoint Defines the position of a the hole using a point. The point can be a vertex on the face or it can be a Point3D object to define any location on the face. If a Point3D object is provided it will be projected onto the plane along the planes normal. The orientation of the hole is defined by the planar face or construction plane. If a vertex is used, the position of the hole is associative to that vertex. If a Point3D object is used the position of the hole is not associative.
setPositionBySketchPoint Defines the position and orientation of the hole using a sketch point.
setPositionBySketchPoints Defines the position and orientation of the hole using a set of sketch points.
setPositionOnEdge Defines the position and orientation of the hole to be on the start, end or center of an edge.

Properties

Name Description
creationOccurrence In order for geometry to be transformed correctly, an Occurrence for creation needs to be specified when the Hole is created based on geometry (e.g. a face or point) in another component AND (the Hole) is not in the root component. The CreationOccurrence is analogous to the active occurrence in the UI A value of null indicates that everything is in the context of a single component.
isDefaultDirection Gets or sets if the hole goes in the default direction or is reversed.
isValid Indicates if this object is still valid, i.e. hasn't been deleted or some other action done to invalidate the reference.
objectType This property is supported by all objects in the API and returns a string that contains the full name (namespace::objecttype) describing the type of the object.

It's often useful to use this in combination with the classType method to see if an object is a certain type. For example: if obj.objectType == adsk.core.Point3D.classType():
participantBodies Gets and sets the list of bodies that will participate in the hole.

If this property has not been set, the default behavior is that all bodies that are intersected by the hole will participate.

This property can return null in the case where the feature has not been fully defined so that possible intersecting bodies can be computed.
targetBaseFeature When creating a feature that is owned by a base feature, set this property to the base feature you want to associate the new feature with. By default, this is null, meaning it will not be associated with a base feature.

Because of a current limitation, if you want to create a feature associated with a base feature, you must set this property AND call the startEdit method of the base feature, create the feature, and then call the finishEdit method of the base feature. The base feature must be in an "edit" state to be able to add any additional items to it.
tipAngle Gets the ValueInput object that defines the angle of the tip of the hole. The default is "118.0 deg" but can be modified by setting it using another Value object.

Accessed From

HoleFeatures.createCounterboreInput, HoleFeatures.createCountersinkInput, HoleFeatures.createSimpleInput

Samples

Name Description
Hole Feature API Sample Demonstrates creating a new hole feature.

Version

Introduced in version August 2014