Options
All
  • Public
  • Public/Protected
  • All
Menu

Type parameters

  • T

Hierarchy

  • PyramidSimpleAffectorsDto

Index

Constructors

constructor

  • new PyramidSimpleAffectorsDto<T>(faces?: T[], affectorPoints?: Point3[], uNumber?: number, vNumber?: number, minHeight?: number, maxHeight?: number, precision?: number): PyramidSimpleAffectorsDto<T>
  • Type parameters

    • T

    Parameters

    • Optional faces: T[]
    • Optional affectorPoints: Point3[]
    • Optional uNumber: number
    • Optional vNumber: number
    • Optional minHeight: number
    • Optional maxHeight: number
    • Optional precision: number

    Returns PyramidSimpleAffectorsDto<T>

Properties

affectMaxHeight

affectMaxHeight: number

Max value to add to the height if affector factor is 1 or subtract from the height if affector factor is -1. This adds to the height if the affector factor > 0 and subtracts from the height if the affector factor is < 0.

default

1

minimum

0

maximum

Infinity

step

0.1

affectMinHeight

affectMinHeight: number

Min value to add to the height if affector factor is 1 or subtract from the height if affector factor is -1. This adds to the height if the affector factor > 0 and subtracts from the height if the affector factor is < 0.

default

0

minimum

0

maximum

Infinity

step

0.1

Optional affectorFactors

affectorFactors: number[]

The affector factors determine if a given affector attracts (value 0 to 1) or repulses (values -1 to 0) the default height of the pyramid elements. If value is not provided, all affector points will use the factor of 1 and will thus attract the heights.

default

undefined

optional

true

affectorPoints

affectorPoints: Point3[]

The affector points affect the height of the pyramid elements. The distance is measured between a center point of the corner points and the attractor point. Then it is remapped to certain values.

default

undefined

Optional affectorRadiusList

affectorRadiusList: number[]

The affector radius indicates the limit of affection. Cells heights that are further away from the affector than this radius will not be adjusted. If value is not provided, all affector points will use the radius of 10.

default

undefined

optional

true

defaultHeight

defaultHeight: number

The default height for the pyramid if it is not affected by any of the affectors.

default

0.2

minimum

-Infinity

maximum

Infinity

step

0.1

faces

faces: T[]

The faces on which to apply the pattern

default

undefined

precision

precision: number

Meshing precision of the drawn model. The lower the number the more precise the drawn model is. Keep in mind that output of this algorithm also contains pure occt shape that can be meshed separately in draw any async commands

default

0.01

minimum

0.000001

maximum

5

step

0.001

uNumber

uNumber: number

The nr of pyramids along u direction of the face

default

10

minimum

1

maximum

Infinity

step

1

vNumber

vNumber: number

The nr of pyramids along v direction of the face

default

5

minimum

1

maximum

Infinity

step

1

Generated using TypeDoc