clip#

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

Class wrapper for EnSight clip module

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

Methods

clip.angle(*args, **kwargs)

Set the angle for a cone clip.

clip.axis(*args, **kwargs)

Set the direction vector for quadric and revolution clips.

clip.axis_point_1(*args, **kwargs)

Clip: axis_point 1

clip.axis_point_2(*args, **kwargs)

Clip: axis_point 2

clip.axis_x(*args, **kwargs)

Clip: axis x

clip.axis_y(*args, **kwargs)

Clip: axis y

clip.axis_z(*args, **kwargs)

Clip: axis z

clip.begin(*args, **kwargs)

Delimit the modifications for clip attributes.

clip.box_axis(*args, **kwargs)

Specify the direction vectors for a box clip.

clip.box_length(*args, **kwargs)

Specify the size of the box clip in the x, y, and z directions

clip.box_max(*args, **kwargs)

Clip: box_max

clip.box_min(*args, **kwargs)

Clip: box_min

clip.box_origin(*args, **kwargs)

Specify the origin of the box clip in reference to the parent part frame

clip.create(*args, **kwargs)

Create a clip part with the currently defined attributes using the currently selected parts as parents.

clip.create_delta(*args, **kwargs)

Specify the delta offset when multiple clip instances will be created.

clip.delta(*args, **kwargs)

Set a delta transform for use with the keyframe animator.

clip.dimension2(*args, **kwargs)

Specify the minimum/maximum range for the non-constant I/J/K extract.

clip.dimension2_step(*args, **kwargs)

Specify the step increment for the non-constant I/J/K extract.

clip.dimension3(*args, **kwargs)

Specify the minimum/maximum range for the non-constant I/J/K extract.

clip.dimension3_step(*args, **kwargs)

Specify the step increment for the non-constant I/J/K extract.

clip.domain(*args, **kwargs)

Specify what type of clip will be created.

clip.end(*args, **kwargs)

Delimit the modifications for clip attributes.

clip.end_point(*args, **kwargs)

Clip: end_point

clip.extents(*args, **kwargs)

Set the clip extents to infinite or finite.

clip.general_equation(*args, **kwargs)

Clip to a specified quadric equation of the form

clip.grid_pts(*args, **kwargs)

Set the number of sample points for a planar grid clip.

clip.ijk_axis(*args, **kwargs)

Display an axis system for a IJK extract.

clip.ijk_scale(*args, **kwargs)

Specify the length of the IJK axis for IJK extracts.

clip.increment(*args, **kwargs)

This command has not yet been documented.

clip.length(*args, **kwargs)

Clip: length

clip.line(*args, **kwargs)

Set an end point for a clip line.

clip.line_1(*args, **kwargs)

Clip: line 1

clip.line_2(*args, **kwargs)

Clip: line 2

clip.line_nodeid(*args, **kwargs)

Create a clip line defined by the two node ids given.

clip.mesh_plane(*args, **kwargs)

Set the plane for XYZ or IJK clips

clip.number_to_create(*args, **kwargs)

Specify the number of clips, at the specified delta, to create.

clip.origin(*args, **kwargs)

Set origin for quadric and revolution clips.

clip.plane(*args, **kwargs)

Set a corner for a clip plane.

clip.plane_1(*args, **kwargs)

Clip: plane 1

clip.plane_2(*args, **kwargs)

Clip: plane 2

clip.plane_3(*args, **kwargs)

Clip: plane 3

clip.plane_nodeid(*args, **kwargs)

Create a clip plane defined by the three node ids given.

clip.plane_showsplineqia(*args, **kwargs)

Clip: plane_showsplineqia

clip.point(*args, **kwargs)

Defines points for the surface of revolution.

clip.point_distance(*args, **kwargs)

Clip: point_distance

clip.point_distance_1(*args, **kwargs)

Clip: point_distance 1

clip.point_distance_10(*args, **kwargs)

Clip: point_distance 10

clip.point_distance_2(*args, **kwargs)

Clip: point_distance 2

clip.point_distance_3(*args, **kwargs)

Clip: point_distance 3

clip.point_distance_4(*args, **kwargs)

Clip: point_distance 4

clip.point_distance_5(*args, **kwargs)

Clip: point_distance 5

clip.point_distance_6(*args, **kwargs)

Clip: point_distance 6

clip.point_distance_7(*args, **kwargs)

Clip: point_distance 7

clip.point_distance_8(*args, **kwargs)

Clip: point_distance 8

clip.point_distance_9(*args, **kwargs)

Clip: point_distance 9

clip.point_radii(*args, **kwargs)

Clip: point_radii

clip.point_radii_1(*args, **kwargs)

Clip: point_radii 1

clip.point_radii_10(*args, **kwargs)

Clip: point_radii 10

clip.point_radii_2(*args, **kwargs)

Clip: point_radii 2

clip.point_radii_3(*args, **kwargs)

Clip: point_radii 3

clip.point_radii_4(*args, **kwargs)

Clip: point_radii 4

clip.point_radii_5(*args, **kwargs)

Clip: point_radii 5

clip.point_radii_6(*args, **kwargs)

Clip: point_radii 6

clip.point_radii_7(*args, **kwargs)

Clip: point_radii 7

clip.point_radii_8(*args, **kwargs)

Clip: point_radii 8

clip.point_radii_9(*args, **kwargs)

Clip: point_radii 9

clip.points(*args, **kwargs)

Clip: points

clip.pts_on_line(*args, **kwargs)

Set the number of sample points for a line clip.

clip.pts_on_spline(*args, **kwargs)

Clip: pts_on_spline

clip.radius(*args, **kwargs)

Set the radius for a sphere or cylinder clip.

clip.revolution_points(*args, **kwargs)

Set the number of points used in the tool of revolution for clipping.

clip.revolve_part(*args, **kwargs)

Clip by revolving a 1D part about an axis.

clip.revolve_partbyname(*args, **kwargs)

Clip by revolving a 1D part about an axis.

clip.rtz_axis(*args, **kwargs)

Specify the axis to be used for RTZ clips.

clip.sample(*args, **kwargs)

Clip: sample

clip.sample_step(*args, **kwargs)

Clip: sample_step

clip.select_default(*args, **kwargs)

Sets the target to the default settings for subsequent attribute modifications.

clip.slider_range_ijk(*args, **kwargs)

Set the I, J, or K range through which an IJK clip part will be modified when in interactive mode, whether using the slider in Manual mode or in Auto or Auto Cycle mode.

clip.slider_step(*args, **kwargs)

Set the value that a X/Y/Z clip part is modified when in interactive mode and the user interface less/greater buttons are selected.

clip.slider_step_ijk(*args, **kwargs)

Set the value that an IJK clip part is modified when in interactive mode and the user interface less/greater buttons are selected.

clip.slider_x(*args, **kwargs)

Set the min/max X/Y/Z extents in the user interface for a clip of constant X/Y/Z.

clip.slider_y(*args, **kwargs)

Set the min/max X/Y/Z extents in the user interface for a clip of constant X/Y/Z.

clip.slider_z(*args, **kwargs)

Set the min/max X/Y/Z extents in the user interface for a clip of constant X/Y/Z.

clip.spline_id(*args, **kwargs)

Clip: spline_id

clip.spline_location(*args, **kwargs)

This command has not yet been documented.

clip.spline_name(*args, **kwargs)

This command has not yet been documented.

clip.tool(*args, **kwargs)

Set the clipping tool.

clip.type(*args, **kwargs)

This command has not yet been documented.

clip.update_to_newtoollocation(*args, **kwargs)

This command has not yet been documented.

clip.value(*args, **kwargs)

Specify the constant plane value for XYZ or IJK clips.

clip.x_max_infinite(*args, **kwargs)

Clip: x_max_infinite

clip.x_min_infinite(*args, **kwargs)

Clip: x_min_infinite

clip.y_max_infinite(*args, **kwargs)

Clip: y_max_infinite

clip.y_min_infinite(*args, **kwargs)

Clip: y_min_infinite

clip.z_max_infinite(*args, **kwargs)

Clip: z_max_infinite

clip.z_min_infinite(*args, **kwargs)

Clip: z_min_infinite
On this page
Show Source