volume_rendering_child

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

Bases: Group

‘child_object_type’ of volume_rendering.

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.
clip_planes	If On, then cut the planes down by extents of density variable min and max.
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	‘colour_mode’ child.
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.
instancing_transform	Defines the TRANSFORM object that is used for the object instancing.
lighting	‘lighting’ child.
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.
make_edges_transparent	If On, then all free edges are made to be transparent, lessening fringing artifacts.
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.
normals_from_views	A list of VIEW objects from which we will grab the normal from and form union with Volume Rendering Normals.
number_of_contours	Specifies number of contour lines in a contour plot.
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.
specular_lighting	‘specular_lighting’ child.
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.
tile_texture	Toggles tiling of the texture.
transform_texture	Toggles transforming (spherical) of the texture.
transparency	‘transparency’ child.
transparency_colour_map	The name of the colour map to use when rendering transparency the object.
variable	The name of the variable used to create the object. Should be set equal to the name of a currently defined VARIABLE object.
variable_boundary_values	Sets the type of boundary values to be presented for variables in this object (Conservative or Hybrid).
visibility	Toggles the visibility of this graphics object in the viewer. THIS PARAMETER IS DEPRECATED!.
volume_rendering_max	The maximum value of a variable which represents transparency when using a “User Specified” range.
volume_rendering_min	The minimum value of a variable which represents transparency when using a “User Specified” range.
volume_rendering_normals	The data is a list of normal components for which to generate volume rendering planes from.
volume_rendering_range	Sets the method used to calculate the extents of the density. “Global” uses the range of values in the problem domain. “Local” uses the range of values on the current object.
volume_rendering_scale	Sets whether to calculate the object density with a Linear or Logarithmic scale. By default, the scale is Linear.
volume_resolution	The resolution of the density, or number of plane cuts per axis.
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
volume_rendering	‘volume_rendering’ child.
internal_volume_rendering	‘internal_volume_rendering’ child.