internal_point_cloud_child#

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

Bases: Group

‘child_object_type’ of internal_point_cloud.

Attributes

Attribute

Summary

add_sample_vertex_normals

If true, calculate vertex normals for sampling geometry.

apply_instancing_transform

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

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

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

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.

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

‘line_width’ child.

location_list

A comma delimited list of locator names.

locator_sampling_method

Specifies point cloud sampling method on a surface.

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

If set On, all vectors are plotted with the same length (show direction only).

number_of_samples

‘number_of_samples’ child.

option

‘option’ child.

point_symbol

‘point_symbol’ child.

random_seed

The seed to be used for a random number series.

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

This indicates whether to use ‘Reduction Factor’ to reduce the number of items, or to use ‘Maximum Number of Items’.

sample_spacing

A value between 0 and 1 relative to domain extents indicating number points in one direction for grid sampling.

sampling_accuracy

An indicator for points sampling accuracy.

sampling_aspect_ratio

Specifies spacing aspect ratio for grid sampling.

sampling_grid_angle

Specifies the rotation angle for a sampling grid.

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.

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

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

internal_point_cloud

‘internal_point_cloud’ child.