SketchDimensions.addOffsetDimension Method

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

Description

Creates a new linear dimension constraint between the two input entities. The first input entity must be a sketch line. The second entity can be a point or a line that is parallel to the first. The dimension controls the distance as measured perpendicular to the first input line.

Syntax

"sketchDimensions_var" is a variable referencing a SketchDimensions object.
# Uses no optional arguments.
returnValue = sketchDimensions_var.addOffsetDimension(line, entityTwo, textPoint)

# Uses optional arguments.
returnValue = sketchDimensions_var.addOffsetDimension(line, entityTwo, textPoint, isDriving)
"sketchDimensions_var" is a variable referencing a SketchDimensions object.

#include <Fusion/Sketch/SketchDimensions.h>

// Uses no optional arguments.
returnValue = sketchDimensions_var->addOffsetDimension(line, entityTwo, textPoint);

// Uses optional arguments.
returnValue = sketchDimensions_var->addOffsetDimension(line, entityTwo, textPoint, isDriving);

Return Value

Type Description
SketchOffsetDimension Returns the newly created dimension or null if the creation failed.

Parameters

Name Type Description
line SketchLine The SketchLine to dimension to.
entityTwo SketchEntity The parallel SketchLine or SketchPoint to dimension to. If a SketchLine is used it must be parallel to the first line.
textPoint Point3D A Point3D object that defines the position of the dimension text.
isDriving boolean Optional argument that specifies if a driving (the dimension controls the geometry) or a driven (the geometry controls the dimension) dimension is created. If not provided a driving dimension will be created.

This is an optional argument whose default value is True.

Samples

Name Description
SketchDimensions.addOffsetDimension Demonstrates the SketchDimension.addOffsetDimension method.

Version

Introduced in version August 2014