HoleFeatureInput.setPositionByPlaneAndOffsets Method

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.

Syntax

Python
C++

"holeFeatureInput_var" is a variable referencing a HoleFeatureInput object.

# Uses no optional arguments.
returnValue = holeFeatureInput_var.setPositionByPlaneAndOffsets(planarEntity, point, edgeOne, offsetOne)

# Uses optional arguments.
returnValue = holeFeatureInput_var.setPositionByPlaneAndOffsets(planarEntity, point, edgeOne, offsetOne, edgeTwo, offsetTwo)

"holeFeatureInput_var" is a variable referencing a HoleFeatureInput object.

#include <Fusion/Features/HoleFeatureInput.h>

// Uses no optional arguments.
returnValue = holeFeatureInput_var->setPositionByPlaneAndOffsets(planarEntity, point, edgeOne, offsetOne);

// Uses optional arguments.
returnValue = holeFeatureInput_var->setPositionByPlaneAndOffsets(planarEntity, point, edgeOne, offsetOne, edgeTwo, offsetTwo);

Parameters

planarEntity

Base

The planar BRepFace or ConstructionPlane object that defines the orientation of the hole. The natural direction of the hole will be opposite the normal of the face or construction plane.

point

Point3D

A Point3D object that defines the approximate initial position of the hole. The point will be projected onto the plane. This point should be close to the final position of the hole and is used to determine which solution out of several possible solutions should be chosen for the hole location.

This point is defined in the coordinate system of the native entity used for the planarEntity argument. For example, if the planarEntity argument is a proxy to a BRepFace, the point argument must be in the coordinate system of the component of the native face, not the proxy.

edgeOne

BRepEdge

A linear BRepEdge object that the position of the hole will be measured from. The position of the hole will be measured along a perpendicular from this edge.

offsetOne

ValueInput

A ValueInput object that defines the offset distance from edgeOne. If the ValueInput uses a real then it is interpreted as centimeters. If it is a string then 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.

edgeTwo

BRepEdge

You can optionally define a second edge and offset to specify the position of the hole. If you use a second edge it has the same requirements as the edgeOne argument. If you provide a second edge you must also provide the offsetTwo argument.

This is an optional argument whose default value is null.

offsetTwo

ValueInput

If edgeTwo is defined, you must provide this argument which is a ValueInput object that defines the offset from the edgeTwo. If the ValueInput uses a real then it is interpreted as centimeters. If it is a string then 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.

This is an optional argument whose default value is null.

Samples

holeFeatures.add

Demonstrates the holeFeatures.add method using the createSimpleInput method. To use this sample, have a design open with a box. Select the face for the hole and two edges to define the position of the hole.

Type	Description
boolean	Returns true if successful.

HoleFeatureInput.setPositionByPlaneAndOffsets Method

Description

Syntax

Return Value

Parameters

Samples

Version

Name	Type	Description
planarEntity	Base	The planar BRepFace or ConstructionPlane object that defines the orientation of the hole. The natural direction of the hole will be opposite the normal of the face or construction plane.
point	Point3D	A Point3D object that defines the approximate initial position of the hole. The point will be projected onto the plane. This point should be close to the final position of the hole and is used to determine which solution out of several possible solutions should be chosen for the hole location. This point is defined in the coordinate system of the native entity used for the planarEntity argument. For example, if the planarEntity argument is a proxy to a BRepFace, the point argument must be in the coordinate system of the component of the native face, not the proxy.
edgeOne	BRepEdge	A linear BRepEdge object that the position of the hole will be measured from. The position of the hole will be measured along a perpendicular from this edge.
offsetOne	ValueInput	A ValueInput object that defines the offset distance from edgeOne. If the ValueInput uses a real then it is interpreted as centimeters. If it is a string then 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.
edgeTwo	BRepEdge	You can optionally define a second edge and offset to specify the position of the hole. If you use a second edge it has the same requirements as the edgeOne argument. If you provide a second edge you must also provide the offsetTwo argument. This is an optional argument whose default value is null.
offsetTwo	ValueInput	If edgeTwo is defined, you must provide this argument which is a ValueInput object that defines the offset from the edgeTwo. If the ValueInput uses a real then it is interpreted as centimeters. If it is a string then 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. This is an optional argument whose default value is null.