vctarrow#

class ansys.api.pyensight.ensight_api.vctarrow(session: Session)#

Class wrapper for EnSight vctarrow module

This class acts as a proxy for the EnSight Python module ensight.vctarrow

Methods

vctarrow.arrow_attach(p0)

Vctarrow: arrow_attach

vctarrow.arrow_location(p0)

Control the location of the arrows

vctarrow.arrow_type(p0)

Change the visual representation of the arrow shafts

vctarrow.begin()

Delimit the modifications for vector arrow attributes

vctarrow.color_by_projection(p0)

Vctarrow: color_by_projection

vctarrow.component(p0, p1, p2)

Specify a scaling factor for each component of the vector variable, to be used in calculating both the magnitude and direction of the vector arrow.

vctarrow.create()

Create a new vector arrow part using the currently defined attributes and selected parent parts.

vctarrow.density(p0)

Control the fraction of the parent's nodes which will display a vector.

vctarrow.display_offset(p0)

Specify a visual offset for the vectors from the surface.

vctarrow.end()

Delimit the modifications for vector arrow attributes

vctarrow.instant(p0)

Vctarrow: instant

vctarrow.projection(p0)

Apply a projection to the vectors prior to display

vctarrow.scale_factor(p0)

Control the length of the vector arrows

vctarrow.select_default()

Sets the target to the default settings for subsequent attribute modifications.

vctarrow.threshold_high(p0)

Set the low or high threshold value

vctarrow.threshold_low(p0)

Set the low or high threshold value

vctarrow.thresholds(p0)

Apply a threshold filter to the selection of vectors for display.

vctarrow.tip_rgb(p0, p1, p2)

Change the color of the arrow tips

vctarrow.tip_shaft(p0)

Vctarrow: tip_shaft

vctarrow.tip_shape(p0)

Change the visual representation of the arrow tips

vctarrow.tip_size(p0)

Vctarrow: tip_size

vctarrow.tip_size_fixed(p0)

This command has not yet been documented

vctarrow.tip_size_proportional(p0)

This command has not yet been documented

vctarrow.tip_size_rep(p0)

Set the method for determining tip size

vctarrow.variable(p0)

Specify the vector variable to be used for vector arrow creation.