Measures Functions

Measures are functions that compute a result from data captured from the geometry area. Measures are application-related objects and they will not be displayed in the dictionary if you do not have the right product installed (Part Design or Generative Shape Design for instance).

This page discusses:

AnchorVolume

Signature

AnchorVolume(UdfResult: Body): VOLUME

Inputs

Name Input/Output Required? Type Comment
UdfResult In Body -

Returned Value

VOLUME

centerofgravity

Constructs the center of gravity.

Body->centerofgravity

Constructs the center of gravity of a solid (i. e. a PartBody type Feature). In case of a face, the center of gravity of the equivalent volume is computed with a unit thickness. Whereas, for a profile, it is computed with a unit section swept along the boundary.

Gets the center of gravity by valuating its three coordinates as output Inputs.

Signature

Body->centerofgravity (x: out Length, y: out Length, z: out Length): VoidType

Inputs

  • x(LENGTH): abscissa of the Body's center of gravity, as an output argument
  • y(LENGTH): ordinate of the Body's center of gravity, as an output argument
  • z(LENGTH): applicate of the Body's center of gravity, as an output argument

Returned Value

None

centerofgravity

Returns the center of gravity as a point.

Signature

centerofgravity (Body, ...): Point

Inputs

  • (Body): solid or face or profile whose center of gravity is sought

Returned Value

  • Point: center of gravity of the input solid, face or profile

Sample

Geometrical Set.1\Point.12 = centerofgravity (PartBody)

distance

Returns the distance between two Bodies of a Part.

Signature

distance(Body, Body): Length

Inputs

  • (Body): second Body

Returned Value

LENGTH: distance between the first and second Bodies

minimumCurvatureRadius

Returns the minimum radius of curvature for any type of curve.

Signature

minimumCurvatureRadius(Curve): Length

Inputs

  • (Curve): curve whose minimum radius of curvature is sought

Returned Value

LENGTH: minimum radius of curvature of the input curve

nbDomains

Returns the number of non-connex domains of a given Body.

Signature

nbDomains(Body): Integer

Inputs

  • (Body): Body whose number of domains is sought

Returned Value

  • Integer: number of domains of the input Body

length

Returns the length of curve elements.

length (edge)

Returns the length of a given edge.

Signature

length(CATEdge): Length

Inputs

  • (CATEdge): edge whose length is sought

Returned Value

  • LENGTH: length of the input edge

length (curve)

Returns the length of a curve.

Signature

length(Curve, ..): Length

Inputs

  • (Curve): curve whose length is sought

Returned Value

  • LENGTH: length of the input curve

length (semi-curve)

Returns the length of a semi-curve, starting from a given point located on the curve, until the curve starting or ending point, depending on the given boolean's value.

Signature

length(Curve, Point, Boolean): Length

Inputs

  • (Curve): curve whose semi-curve is to be measured
  • (Point): point on the curve to separate it into two semi-curves
  • (Boolean): boolean to specify which semi-curve is to be measured

Returned Value

  • LENGTH: length of the input curve's semi-curve defined by the input point and boolean.

length (curve arc)

Returns the length of the curve arc of a given curve located between two given points located on the curve.

Signature

length(Curve, Point, Point): Length

Inputs

  • (Curve): curve whose arc's length is sought
  • (Point): first point located on the input curve to limit the curve arc to be measured
  • (Point): second point located on the input curve to limit the curve arc to be measured

Returned Value

  • LENGTH: length of the input curve's curve arc located between the two input points.

perimeter

Returns the perimeter of a surface or surfaces (in that case, the returned perimeter is the sum of the surfaces' perimeters).

Signature

perimeter(Surface, ..): Length

Inputs

  • (Surface): surface or surfaces whose overall perimeter is sought

Returned Value

  • LENGTH: input surface's perimeter or sum of the input surfaces' perimeters

curvature

Returns the curvature of a curve at a given point.

Signature

curvature(crv: Curve, pt: Point): Real

Inputs

  • crv(Curve): curve whose curvature at pt is sought
  • pt(Point): point located on crv to locate where the curvature is to be measured

Returned Value

  • Real: curvature of crv at pt

angleoriented

Returns the angle.

angleoriented (directions)

Returns the angle between two directions and oriented by a third direction.

Signature

angleoriented(Direction, Direction, Direction): Angle

Inputs

  • (Direction): direction the angle is starting from
  • (Direction): direction the angle is ending at
  • (Direction): direction to determine positive and negative angles

Returned Value

  • ANGLE: angle between the first two directions and oriented by the third one

angleoriented (lines)

Returns an angle between two lines and oriented by the direction.

Signature

angleoriented(Line, Line, Direction): Angle

Inputs

  • (Line): line the angle is starting from
  • (Line): line the angle is ending at
  • (Direction): direction to determine positive and negative angles

Returned Value

  • ANGLE: angle between the two lines and oriented by the direction

angleoriented (planes)

Returns an angle between two planes and oriented by the direction.

Signature

angleoriented(Plane, Plane, Direction): Angle

Inputs

  • (Plane): plane the angle is starting from
  • (Plane): plane the angle is ending at
  • (Direction): direction to determine positive and negative angles

Returned Value

  • ANGLE: angle between the two planes and oriented by the direction

angle

Returns the angle.

angle (lines)

Returns the angle between two lines.

The input lines have got a direction. Those two directions define together two geometrical (i. e. non-oriented) angles whose sum equals 360deg: one is between 0deg and 180deg and the other one is between 180deg and 360deg. The angle() constructor returns the geometrical angle between the input lines' directions which is between 0deg and 180deg.

Let line3 be an Invert Feature whose element to invert is line2. We have:

  • angle(line1, line2) = angle(line2, line1), and
  • angle(line1, line3) = 180deg - angle(line1, line2).

Signature

angle(Plane, Plane): Angle

Inputs

  • (Plane): first plane to determine the geometrical angle
  • (Plane): second plane to determine the geometrical angle

Returned Value

  • ANGLE: the geometrical angle between the input lines' directions which is between 0deg and 180deg

Sample

angle(`PartBody\Line.1` ,`PartBody\Line.2` )
angle(`PartBody\Line.1` ,`PartBody\Inverse.1 (Line.2 inversed)` )
angle(`PartBody\Line.2` ,`PartBody\Line.1` )
angle(`PartBody\Line.1` ,`PartBody\Line.3 (included in xy plane)` )
angle(`PartBody\Line.1` ,`PartBody\Line.4 (included in zx plane)` )
angle(`PartBody\Line.1` ,`PartBody\Inverse.2 (Line.3 inversed)` )

angle (points)

Returns the angle between the lines "Center-Point1" and "Center-Point2".

Signature

angle(center: Point, pt1: Point, pt2: Point): Angle

Inputs

  • center(Point): angle's vertex
  • pt1(Point): angle's first extremity
  • pt2(Point): angle's second extremity

Returned Value

  • ANGLE: angle(center, pt1, pt2) = angle(line(center, pt1), line(center, pt2))

Sample

angle(PartBody\Intersect.1 ,PartBody\Point.9 ,PartBody\Point.10 )
angle(PartBody\Intersect.1 ,PartBody\Point.10 ,PartBody\Point.9 )

angle (planes)

Returns the angle between two planes.

The input planes have got a normal. Those two normals define together two geometrical (i.e. non-oriented) angles whose sum equals 360deg: one is between 0deg and 180deg and the other one is between 180deg and 360deg. The angle() constructor returns the geometrical angle between the input planes' normals which is between 0deg and 180deg.

Let plane3 be an Invert Feature whose element to invert is plane2. We have:

  • angle(plane1, plane2) = angle(plane2, plane1), and
  • angle(plane1, plane3) = 180deg - angle(plane1, plane2).

Signature

angle(Plane, Plane): Angle

Inputs

  • - (Plane): first plane to determine the geometrical angle
  • - (Plane): second plane to determine the geometrical angle

Returned Value

  • ANGLE: the geometrical angle between the input planes' normals which is between 0deg and 180deg

Sample

angle(`xy plane` ,PartBody\Plane.1 )
angle(PartBody\Plane.1 ,`xy plane` )
angle(`xy plane` ,`PartBody\Plane.1 (inversed)` )
angle(`PartBody\Plane.1 (inversed)` ,`xy plane` )
angle(`PartBody\xy plane (inversed)` ,PartBody\Plane.1 )
angle(PartBody\Plane.1 ,`PartBody\xy plane (inversed)` )
angle(`PartBody\xy plane (inversed)` ,`PartBody\Plane.1 (inversed)` )
angle

angle (directions)

Returns the angle between two directions.

The input directions define together two geometrical (i. e. non-oriented) angles whose sum equals 360deg: one is between 0deg and 180deg and the other one is between 180deg and 360deg. The angle() constructor returns the geometrical angle between the input directions which is between 0deg and 180deg. We have:

  • angle(direction1, direction2) = angle(direction2, direction1), and
  • angle(diection1, -direction2) = 180deg - angle(direction1, direction2).

Signature

angle(Direction, Direction): Angle

Inputs

  • (Direction): first direction to determine the geometrical angle
  • (Direction): second direction to determine the geometrical angle

Returned Value

  • ANGLE: the geometrical angle between the input directions which is between 0deg and 180deg

Sample

angle(direction(`PartBody\Line.1`) ,direction(`PartBody\Line.2`) )
angle(direction(`PartBody\Line.1`) ,direction(PartBody\Plane.1) )
angle(direction(PartBody\Plane.1) ,direction(`PartBody\Line.1`) )
angle(direction(`xy plane`) ,direction(PartBody\Plane.1) )

area

Returns the area.

area (face)

Returns the area of a given face.

Signature

area(CATFace, ..): Area

Inputs

  • (CATFace): face whose area is sought

Returned Value

  • AREA: area of the input face

area (surface)

Returns the area of a given surface.

Signature

area(Surface, ..): Area

Inputs

  • (Surface): surface whose area is sought

Returned Value

  • AREA: area of the input surface

area (closed curve)

Returns the area delimited by a given closed curve.

Signature

area(Curve, ..): Area

Inputs

  • (Curve): closed curve delimiting the domain whose area is sought

Returned Value

  • AREA: area delimited by the input closed curve

distancedir

Returns the distance between two Bodies of a Part along a direction (volume Bodies are not taken into account).

Note:

Distancedir is based on the same algorithm as the Distance Analysis. When the two analyzed elements have the same dimension, distancedir performs a two-way computation after which the minimum distance is kept.

  1. The first element is discretized, and a distance computation is done with the other element.
  2. The second element is discretized, and a computation is done with other element.

The minimum result is kept. When the two elements have a different dimension, the element with the lowest dimension is discretized.

Signature

distancedir(Body, Body, Direction): Length

Inputs

  • (Body): second Body
  • (Direction): direction to measure the distance between the two Bodies along

Returned Value

  • LENGTH: distance between the two input Bodies along the input direction

Point->coord

Gets coordinates.

Note: You can read point coordinates in different axis systems. For more information, see Reading Point Coordinates in Different Axis Systems.

Point->coord (output arguments)

Gets the coordinates of a point by valuating them as output arguments.

Signature

Point->coord (x: out Length, y: out Length, z: out Length): VoidType

Inputs

  • x(LENGTH): abscissa of the point, as an output argument
  • y(LENGTH): ordinate of the point, as an output argument
  • z(LENGTH): applicate of the point, as an output argument

Returned Value

None

Point->coord (rank)

Returns a point coordinate whose rank (1, 2 or 3) is given.

Signature

Point->coord (rank: Integer): Length

Inputs

  • rank(Integer): rank of the point coordinate to return (1 for x; 2 for y; 3 for z)

Returned Value

  • LENGTH: the rank-th coordinate of the point

volume

Returns the volume.

volume (closed surface)

Returns the volume delimited by a closed surface.

Signature

volume(closed_surface: Surface, ..): Volume

Inputs

  • closed_surface(Surface): closed surface delimiting the volume to measure

Returned Value

  • VOLUME: volume delimited by the input closed surface

volume (volume)

Returns the volume of a given volume.

Signature

volume(VolumeGeo, ..): Volume

Inputs

Returned Value

  • VOLUME: volume of the input volume

AxisSystem.AxisSystemSetCurrent()

Signature

AxisSystem.AxisSystemSetCurrent(input2 : Boolean)

Inputs

NameInput/OutputRequired?TypeComment
input2InBoolean-

AxisSystem.GetDirectionOfAxis()

Signature

AxisSystem.GetDirectionOfAxis(originx : Real, originy : Real, originz : Real, dir1x : Real, dir1y : Real, dir1z : Real, dir2x : Real, dir2y : Real, dir2z : Real, dir3x : Real, dir3y : Real, dir3z : Real)

Inputs

NameInput/OutputRequired?TypeComment
originxOutReal-
originyOutReal-
originzOutReal-
dir1xOutReal-
dir1yOutReal-
dir1zOutReal-
dir2xOutReal-
dir2yOutReal-
dir2zOutReal-
dir3xOutReal-
dir3yOutReal-
dir3zOutReal-

AxisSystem.IsAxisSystemActive()

Signature

AxisSystem.IsAxisSystemActive(isAxisSystemActive : Boolean)

Inputs

NameInput/OutputRequired?TypeComment
isAxisSystemActiveOutBoolean-

Body.IsInfinite()

Signature

Body.IsInfinite(isInfinite : Boolean)

Inputs

NameInput/OutputRequired?TypeComment
isInfiniteOutBoolean-