TexturePattern

class ansys.speos.core.input_files.texture_3d.TexturePattern(position=(0.0, 0.0, 0.0), x_direction=(1.0, 0.0, 0.0), y_direction=(0.0, 1.0, 0.0), scale=(1.0, 1.0, 1.0))

Bases: ansys.speos.core.input_files._base._ValueComparable

Placement of one pattern of a Speos 3D Texture.

Parameters:

positionTuple[float, float, float], optional

Origin of the pattern, in the axis system of the 3D Texture. By default, (0.0, 0.0, 0.0).

x_directionTuple[float, float, float], optional

Orientation of the pattern along the X direction of the axis system. By default, (1.0, 0.0, 0.0).

y_directionTuple[float, float, float], optional

Orientation of the pattern along the Y direction of the axis system. By default, (0.0, 1.0, 0.0).

scaleTuple[float, float, float], optional

Scale factors along the X, Y and Z directions, 1 meaning 100 percent of the original pattern size. By default, (1.0, 1.0, 1.0).

Parameters:

• position (Tuple[float, float, float])

• x_direction (Tuple[float, float, float])

• y_direction (Tuple[float, float, float])

• scale (Tuple[float, float, float])

Notes

Construction and setters validate finite three-component vectors before storing them as immutable tuples. Editing a pattern shared with a mapping does not notify the mapping; its uniform-scale constraint is rechecked when validating or saving it.

Overview

Methods

validate

Check vector dimensions and finite coordinates.

Properties

position	Pattern origin.
x_direction	Pattern X direction.
y_direction	Pattern Y direction.
scale	Pattern scale factors.

Import detail

from ansys.speos.core.input_files.texture_3d import TexturePattern

Property detail

property TexturePattern.position: Tuple[float, ...]

Pattern origin.

Parameters:

valuesTuple[float, float, float]

New origin of the pattern, in the axis system of the 3D Texture.

Returns:

Tuple[float, …]

Three finite Cartesian coordinates.

property TexturePattern.x_direction: Tuple[float, ...]

Pattern X direction.

Parameters:

valuesTuple[float, float, float]

New orientation of the pattern along the X direction of the axis system.

Returns:

Tuple[float, …]

Three finite direction coordinates.

property TexturePattern.y_direction: Tuple[float, ...]

Pattern Y direction.

Parameters:

valuesTuple[float, float, float]

New orientation of the pattern along the Y direction of the axis system.

Returns:

Tuple[float, …]

Three finite direction coordinates.

property TexturePattern.scale: Tuple[float, ...]

Pattern scale factors.

Parameters:

valuesTuple[float, float, float]

New scale factors along the X, Y and Z directions, 1 meaning 100 percent of the original pattern size.

Returns:

Tuple[float, …]

Three finite scale factors.

Method detail

TexturePattern.validate()

Check vector dimensions and finite coordinates.

Raises:

ValueError

If a vector is not a finite three-component vector.