particle_cloud_child

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

Bases: Group

‘child_object_type’ of particle_cloud.

Attributes

Attribute	Summary
apply_instancing_transform	Toggles the instancing transformation for this graphics object in the viewer.
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_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.
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_width	Controls the width (in pixels) of lines drawn for this graphics object.
max	The maximum value of a variable in the colour map when using a “User Specified” range.
maximum_number_of_items	‘maximum_number_of_items’ child.
min	The minimum value of a variable in the colour map when using a “User Specified” range.
normalized	‘normalized’ child.
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.
reduction_factor	Reduces the number of items that should be displayed for a particular locator.
reduction_or_max_number	‘reduction_or_max_number’ child.
specular_lighting	Toggles the specular lighting of this object in the viewer.
surface_drawing	Sets the algorithm used to shade the faces for this graphics object.
symbol	‘symbol’ child.
symbol_size	A scaling factor for all symbols in the plot.
symbol_size_mode	Determines whether the symbol size is defined relative to the problem size or it is an absolute size.
transparency	Set between 0.0 (fully opaque) and 1.0 (fully transparent) to control the transparency of this graphics object in the viewer.
variable	The name of the variable used to create the object. Should be set equal to the name of a currently defined VARIABLE object.
visibility	‘visibility’ child.
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
particle_cloud	‘particle_cloud’ child.