polyline_child#

class ansys.cfx.core.generated.post_processing.settings_261.polyline_child.polyline_child(name: str | None = None, parent=None)#

Bases: Group

‘child_object_type’ of polyline.

Attributes

Attribute

Summary

apply_instancing_transform

Toggles the instancing transformation for this graphics object in the viewer.

boundary_list

A list of boundary objects.

colour

‘colour’ child.

colour_map

The name of the colour map to use when colouring the object.

colour_mode

Sets the mode used to colour the object. If set equal to “Constant” then the “Colour” parameter is used to determine the plot colour. If set equal to “Variable”, then the “Colour Variable” parameter is used.

colour_scale

Sets whether to colour the object with a Linear or Logarithmic scale. By default, the colour scale is Linear.

colour_variable

The name of the variable to be used in colouring the object. Should be set equal to the name of a currently defined VARIABLE object.

colour_variable_boundary_values

Sets the type of boundary values to be presented for colour variables in this object (Conservative or Hybrid).

contour_level

The contour level specified in a user surface.

contour_name

The name of the contour object specified in a user surface.

domain_list

The list of domains over which to define this object.

draw_contours

Enables/disables drawing of the contour lines.

input_file

The name of the file to be read that contains the definition of one or more polylines or user surfaces and associated path variables.

instancing_transform

Defines the TRANSFORM object that is used for the object instancing.

line_width

‘line_width’ child.

location

A locator name.

max

The maximum value of a variable in the colour map when using a “User Specified” range.

min

The minimum value of a variable in the colour map when using a “User Specified” range.

number_of_contours

Specifies number of contour lines in a contour plot.

option

‘option’ child.

range

Sets the method used to calculate the extents of the colour map on an object. “Global” uses the range of values in the problem domain. “Local” uses the range of values on the current object.

section_name

The section name in the file to be read that contains the definition of the polyline or user surface and associated path variables.

visibility

Toggles the visibility of this graphics object in the viewer. THIS PARAMETER IS DEPRECATED!.

object_view_transform

This object contains object transformation info to be processed by the viewer. Like instance transform, this object should be associated with each geometry. It is usually specified as a sub-object.

Methods

Method

Summary

hide

Hide the object in a given view(s).

show

Show the object in a given view(s).

suspend

Suspend immediate update for the object.

unsuspend

Restore immediate update for the object.

Included in:

Parent

Summary

polyline

‘polyline’ child.