surface_of_revolution_child#

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

Bases: Group

‘child_object_type’ of surface_of_revolution.

Attributes

Attribute

Summary

apply_instancing_transform

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

apply_texture

Toggles display of the texture.

blend_texture

Toggles blending of the texture.

colour

A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used when colouring the faces of an object by constant colour.

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).

culling_mode

Controls the face culling of this object in the viewer.

domain_list

The list of domains over which to define this object.

draw_contours

Enables/disables drawing of the contour lines.

draw_faces

Toggles the visibility filled faces for this graphics object in the viewer.

draw_lines

Toggles the visibility of lines around each face of this graphics object.

ending_axial_shift

Shift in the axial direction for the final theta location.

ending_radial_shift

Shift in the radial direction for the final theta location.

instancing_transform

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

lighting

Toggles the lighting of this graphics object in the viewer.

line_colour

A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used for colouring the lines on a graphics object.

line_colour_mode

Determines where to get the line colour from.

line_width

Controls the width (in pixels) of lines drawn for this graphics object.

location_list

A comma delimited list of locator names.

max

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

meridional_point_1

A-R coordinates defining a point in meridional plane.

meridional_point_2

A-R coordinates defining a point in meridional plane.

meridional_points

Number of points in the meridional plane (used in sample mode).

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.

principal_axis

Specifies the principal axis used in instance rotation.

project_to_ar_plane

Enables/disables projecting of line points to AR plane before the generation of surface of revolution.

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.

render_edge_angle

The angle between two faces used to limit visible edges in a wireframe.

rotation_axis_from

An XYZ triple defining the first point of the rotation axis.

rotation_axis_to

An XYZ triple defining the second point of the rotation axis.

rotation_axis_type

Specifies the rotation axis type in the transformation. If it is set to ‘Principal Axis’, Principal Axis parameter setting is used. It is set to ‘Rotation Axis’, parameters Rotation Axis From and Rotation Axis To are used for the axis definition.

specular_lighting

Toggles the specular lighting of this object in the viewer.

starting_axial_shift

Shift in the axial direction for the initial theta location.

starting_radial_shift

Shift in the radial direction for the initial theta location.

surface_drawing

Sets the algorithm used to shade the faces for this graphics object.

texture_angle

The texture angle in degrees.

texture_direction

The direction of texture projection to the object.

texture_file

The texture file to display on the object.

texture_material

The material to use for texture.

texture_position

X-Y position of the texture.

texture_scale

The texture scale.

texture_type

The type of texture to use.

theta_max

Upper bound of Theta coordinate for the surface.

theta_min

Lower bound of Theta coordinate for the surface.

theta_points

Number of Sample points in T direction (turbo coordinate).

tile_texture

Toggles tiling of the texture.

transform_texture

Toggles transforming (spherical) of the texture.

transparency

Set between 0.0 (fully opaque) and 1.0 (fully transparent) to control the transparency of this graphics object in the viewer.

use_angle_range

If set to true Theta Min and Theta Max are used to limit the surface. Otherwise, a 360 degree surface is generated.

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

surface_of_revolution

‘surface_of_revolution’ child.