plane_child

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

Bases: Group

‘child_object_type’ of plane.

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.
bound_radius	Radius of Circular Plane Bound.
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.
direction_1_bound	Length of Rectangular Plane Bound.
direction_1_orientation	Orientation of Rectangular Plane Bound length.
direction_1_points	Number of Sample points in direction 1.
direction_2_bound	Width of Rectangular Plane Bound.
direction_2_points	Number of Sample points in direction 2.
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.
invert_plane_bound	Reverses the plane bounds by selecting region outside plane bound.
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.
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.
normal	An XYZ triple describing the normal vector.
number_of_contours	Specifies number of contour lines in a contour plot.
option	‘option’ child.
plane_bound	Defines plane bounding (Circular, Rectangular, None).
plane_type	Indicates if the plane is a slice or sample plane.
point	An XYZ triple which defines a point in space.
point_1	An XYZ triple defining the first point for this object.
point_2	An XYZ triple defining the second point for this object.
point_3	An XYZ triple defining the third point for this object.
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	Toggles the specular lighting of this object in the viewer.
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	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!.
x	The X coordinate value for the location of this object.
y	The Y coordinate value for the location of this object.
z	The Z coordinate value for the location of this object.
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
plane	‘plane’ child.