Radial Dimension

Below we will consider the PMI object defining a surface radius. Not all surfaces are suitable for this measurement. The surface must be defined as a circle or has a radius.

Object is drawn by two points.

Object

You can get any dimension via a GetParameters command, as well as add and remove it via annotation commands. It uses the same type to represent a visual object everywhere.

Common type of the radial dimension object (TypeScript):

export type C3DViewRadialDimension = {
    type: C3DViewObjectTypes.RadialDimension
    uuid: string
    points: {
        p1: C3DViewPoint
        p2: C3DViewPoint
        tp?: C3DViewPoint
    }
    placement: C3DViewPlacement
    ringPlane?: C3DViewPlacement
    options: C3DViewDimensionOptions
    userData: C3DUserData
}

  • type: Necessarily field, value is C3DViewObjectTypes.RadialDimension or string "RadialDimension".

  • uuid: Unique identifier of the dimension, using with selecting.

  • points Grouped point to build the object:

    • p1: first point of the object on the geometry.

    • p2: second point of the object on the geometry.

    • tp: position of the dimension text.

  • placement: Plane to orientate geometry.

  • ringPlane: Plane to show the ring whose radius is being measured.

  • options: Additional options.

  • userData: Custom user data for object.

Note

The new object will be created if the uuid isn’t present.

The exist object with be update if the uuid if the id belongs to it.

Additional Options

The same as for other dimensions.

Type of dimension options (TypeScript):

 export type C3DViewDimensionOptions = {
    text?: string
    underlineText?: boolean
    font?: {
        family?: string,
        size?: number,
    }
    colors?: {
        text?: C3DViewRGB
        textBkg?: C3DViewRGB
        lines?: C3DViewRGB
    }
 }

  • text: The text value of an object.

  • underlineText: The flag for underlined text.

  • font: The group of values to change text font:

    • family: The font family.

    • size: The {r,b,g} values of text colors (the default is black).

  • colors: The group of values to change colors of a graphics object:

    • text: The {r,b,g} values of text colors (the default is black).

    • textBks: The {r,g,b} values of background text colors. The background is transparent if you set the undefined value (the default is transparent).

    • lines: The {r,g,b} values of line colors (the default is black).