frame#

class ansys.api.pyensight.ensight_api.frame(session: Session)#

Class wrapper for EnSight frame module

This class acts as a proxy for the EnSight Python module ensight.frame

Methods

frame.assign(p0)

Assigns selected parts to the specified frame.

frame.begin()

Frame: begin

frame.copy()

Frame: copy

frame.create()

Creates a new frame.

frame.delete()

Deletes selected frames.

frame.description(p0)

Frame: description

frame.end()

Frame: end

frame.len_x(p0)

Sets the display length of the frame x, y, z axes.

frame.len_y(p0)

Sets the display length of the frame x, y, z axes.

frame.len_z(p0)

Sets the display length of the frame x, y, z axes.

frame.line_width(p0)

Sets the line width of the displayed frame axes.

frame.mirror_x(p0)

Frame: mirror_x

frame.mirror_xy(p0)

Frame: mirror_xy

frame.mirror_xyz(p0)

Frame: mirror_xyz

frame.mirror_xz(p0)

Frame: mirror_xz

frame.mirror_y(p0)

Frame: mirror_y

frame.mirror_yz(p0)

Frame: mirror_yz

frame.mirror_z(p0)

Frame: mirror_z

frame.modify_begin()

Grouping several frame attributes together that all need to be set before application.

frame.modify_end()

Grouping several frame attributes together that all need to be set before application.

frame.number_of_labels_x(p0)

Frame: #_of_labels_x

frame.number_of_labels_y(p0)

Frame: #_of_labels_y

frame.number_of_labels_z(p0)

Frame: #_of_labels_z

frame.orientation_x(p0, p1, p2)

Sets the orientation of the x, y, z axes of the frame.

frame.orientation_y(p0, p1, p2)

Sets the orientation of the x, y, z axes of the frame.

frame.orientation_z(p0, p1, p2)

Sets the orientation of the x, y, z axes of the frame.

frame.origin(p0, p1, p2)

Sets the location of the origin of a frame in model coordinates.

frame.query_count(args)

Frame: query_count

frame.query_location(args)

Frame: query_location

frame.rgb(p0, p1, p2)

Sets the color of the axes and labels of the selected frame.

frame.select_all()

Selection of all visible frames.

frame.select_begin(*args, **kwargs)

Selection of frames.

frame.select_default()

Deselects all frames, such that subsequent frame attribute commands will modify default frame attributes.

frame.symmetry_angle(p0)

Sets the angle between instances for rotational symmetry.

frame.symmetry_axis(p0)

Sets the major axis to use for rotational symmetry.

frame.symmetry_delta(p0, p1, p2)

Sets the delta values in the xyz directions between instances for translational symmetry.

frame.symmetry_file(args)

Sets the name of the periodic matchfile for the computational symmetry.

frame.symmetry_instances(p0)

Frame: symmetry_instances

frame.symmetry_mirror_x(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_mirror_xy(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_mirror_xyz(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_mirror_xz(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_mirror_y(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_mirror_yz(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_mirror_z(p0)

Sets the flag for mirror symmetry in the x / y / z / xy / yz / xz / xyz directions.

frame.symmetry_rinstances(p0)

Sets the number of instances for rotational symmetry.

frame.symmetry_tinstances(p0)

Sets the number of instances for translational symmetry.

frame.symmetry_type(p0)

Sets the type of periodic symmetry to apply to parts attached to the frame.

frame.symmetry_use_file(p0)

Sets whether a periodic matchfile will be used for specification of the rotational or translational symmetry.

frame.type(p0)

Set the coordinate system type for the frame.

frame.visible(p0)

Set the frame axis visibility on or off

frame.x_labels(p0)

Sets the visibility of labels along the frame x/y/z axis.

frame.y_labels(p0)

Sets the visibility of labels along the frame x/y/z axis.

frame.z_labels(p0)

Sets the visibility of labels along the frame x/y/z axis.