VectorSettings

class cee.ug.VectorSettings()

Specification of how to render vector arrows for the given result on the model, on cutting planes and on isosurfaces.

Use this object to control the visual appearance of vector arrows in the 3D viewer. With colorMode you can specify whether vectors should use a singleVectorColor or the color mapping from the object’s scalar result. You can also setup relative or absolute scaling with scaleMode and perform filtering and clamping of the vector magnitudes (lengths), with setFilteringRange and setClampingRange respectively.

Accessors

Methods

Accessors

cee.ug.VectorSettings.clampingRangeMaximum

The maximum length the vectors will have if clamping is enabled. This will be undefined if clamping is disabled.

cee.ug.VectorSettings.clampingRangeMinimum

The minimum length the vectors will have if clamping is enabled. This will be undefined if clamping is disabled.

cee.ug.VectorSettings.colorMode

The coloring mode of the vector arrows. This can be either single color, as specified by singleVectorColor or color by fringes, where the color is taken from the scalar result in the object on which the vector arrows are mapped.

cee.ug.VectorSettings.drawMaxCount

If there are more vectors than specified with setDrawMaximumCount(), every n’th vector arrow will be skipped to reduce the number of arrows to within maximum count.

When set to 0, all vectors will be drawn

Note! If drawSkipBy is set to value other than 0, this skip by value will be used and maximum count ignored!

cee.ug.VectorSettings.drawMode

The rendering mode for the vector result.

Vectors can either be drawn as 3D arrows (default) or a simplified version

cee.ug.VectorSettings.drawSkipBy

Get number of vectors to skip between each vector that is drawn. Default 0.

If set > 0, will draw every n’th vector. No guarantee of an even distribution.

cee.ug.VectorSettings.dynamicSymmetricArrowsScalarId

The id of the scalar result used to determine directions of dynamic symmetric arrows. Use setVectorTypeDynamicSymmetricArrow to set this value.

cee.ug.VectorSettings.filteringRangeMaximum

The maximum length the vectors need to have to be visible when filtering is enabled. This will be undefined if filtering is disabled.

cee.ug.VectorSettings.filteringRangeMinimum

The minimum length the vectors need to have to be visible when filtering is enabled. This will be undefined if filtering is disabled.

cee.ug.VectorSettings.isClampingEnabled

Whether clamping of this vector result is enabled.

cee.ug.VectorSettings.isFilteringEnabled

Whether filtering of this vector result is enabled.

cee.ug.VectorSettings.projectVectorsOnSurface

Set if the vectors should be projected onto the model surface or not (default is false)

If set to true, all vectors are projected onto the surface using the surface normal in that point to define the plane to project onto.

This works in the similar way to the CuttingPlane::setProjectVectorsOnPlane() method.

NOTE: It is only in effect when having PER_NODE and PER_ELEMENT_NODE vector results

cee.ug.VectorSettings.resultId

The id (>=0) of the vector result. This id corresponds to the id in ModelDirectory.vectorResultArray

cee.ug.VectorSettings.scaleFactor

The scaling factor to use for the vector arrows. This factor is interpreted as either absolute or relative based on scaleMode

cee.ug.VectorSettings.scaleMode

The scaling mode to use for the vector arrows (absolute or relative).

cee.ug.VectorSettings.singleVectorColor

The color to use for the vectors if colorMode is SINGLE.

cee.ug.VectorSettings.vectorType

The visualization type for the vector result. Use the methods setVectorTypeArrow setVectorTypeSymmetricArrow etc to set this property.

Note

vectorType is deprecated: This setter is deprecated and will be removed in a future version. Instead, use setVectorTypeArrow setVectorTypeSymmetricArrow setVectorTypeReverseSymmetricArrow or setVectorTypeDynamicSymmetricArrow

Methods

disableClamping

cee.ug.VectorSettings.disableClamping()

Disables any clamping of the vectors. They will be rendered with the length specified by the vector result and scaling.

Return type

void

disableFiltering

cee.ug.VectorSettings.disableFiltering()

Disables any filtering of the vectors. They will be rendered with the length specified by the vector result and scaling.

Return type

void

getAsProperties

cee.ug.VectorSettings.getAsProperties()

Gets the settings for this object as a Plain Old JavaScript Object (POJO).

Return type

cee.ug.VectorSettingsProperties

setClampingRange

cee.ug.VectorSettings.setClampingRange(clampMinLength, clampMaxLength)

Specifies to clamp all vectors between the given min and max length.

Arguments

  • clampMinLength (number) –

  • clampMaxLength (number) –

Return type

void

When enabled, all vectors will be clamped into the given <clampMinLength, clampMaxLength> range. So if clampMinLength = clampMaxLength, all vectors will be drawn with the same length, regardless of the magnitude of the vector.

Note: The clamping is done before any scaling.

setFilteringRange

cee.ug.VectorSettings.setFilteringRange(minLength, maxLength)

Specifies to show only the vectors whose length lies within the given range.

Arguments

  • minLength (number) –

  • maxLength (number) –

Return type

void

When enabled, only vectors whose length is within the given filter range <filterMinLength, filterMaxLength> will be drawn. All other vectors will be discarded and not drawn.

Note: The filtering is done before any scaling.

setFromProperties

cee.ug.VectorSettings.setFromProperties(props)

Applies the settings in the given properties object to this vector settings

Arguments

  • props (Partial[cee.ug.VectorSettingsProperties]) –

Return type

void

setVectorTypeArrow

cee.ug.VectorSettings.setVectorTypeArrow()

Set the visualization type to ARROW - normal arrows.

Return type

void

setVectorTypeDynamicSymmetricArrow

cee.ug.VectorSettings.setVectorTypeDynamicSymmetricArrow(scalarId)

Set the visualization type to DYNAMIC_SYMMETRIC_ARROW - arrows centered on the node/vertex, with arrow head directions determined by the sign of the scalar value at that point.

Arguments

  • scalarId (number) – The id of the scalar to use to determine arrow directions.

Return type

void

Note that for mapped vectors on cutting planes, isosurfaces and isovolumes, if dynamicSymmetricArrows scalar does not match the scalar mapped to the cutting plane/isosurface/isovolume, then the vectors will not be displayed.

setVectorTypeReverseSymmetricArrow

cee.ug.VectorSettings.setVectorTypeReverseSymmetricArrow()

Set the visualization type to REVERSE_SYMMETRIC_ARROW - arrows centered on the node/vertex, with arrow heads pointing inward in both directions

Return type

void

setVectorTypeSymmetricArrow

cee.ug.VectorSettings.setVectorTypeSymmetricArrow()

Set the visualization type to SYMMETRIC_ARROW - arrows centered on the node/vertex, with arrow heads pointing outwards in both directions

Return type

void