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(p0)Set the angle for a cone clip.
clip.axis(p0, p1, p2)Set the direction vector for quadric and revolution clips.
clip.axis_point_1(p0, p1, p2)Clip: axis_point 1
clip.axis_point_2(p0, p1, p2)Clip: axis_point 2
clip.axis_x(p0, p1, p2)Clip: axis x
clip.axis_y(p0, p1, p2)Clip: axis y
clip.axis_z(p0, p1, p2)Clip: axis z
Delimit the modifications for clip attributes.
clip.box_axis(p0, p1, p2, p3)Specify the direction vectors for a box clip.
clip.box_length(p0, p1, p2)Specify the size of the box clip in the x, y, and z directions
clip.box_max(p0, p1, p2)Clip: box_max
clip.box_min(p0, p1, p2)Clip: box_min
clip.box_origin(p0, p1, p2)Specify the origin of the box clip in reference to the parent part frame
Create a clip part with the currently defined attributes using the currently selected parts as parents.
Specify the delta offset when multiple clip instances will be created.
clip.delta(p0, p1, p2)Set a delta transform for use with the keyframe animator.
clip.dimension2(p0, p1)Specify the minimum/maximum range for the non-constant I/J/K extract.
Specify the step increment for the non-constant I/J/K extract.
clip.dimension3(p0, p1)Specify the minimum/maximum range for the non-constant I/J/K extract.
Specify the step increment for the non-constant I/J/K extract.
clip.domain(p0)Specify what type of clip will be created.
clip.end()Delimit the modifications for clip attributes.
clip.end_point(p0, p1, p2)Clip: end_point
clip.extents(p0)Set the clip extents to infinite or finite.
clip.general_equation(p0, p1, p2, p3, p4, ...)Clip to a specified quadric equation of the form
clip.grid_pts(p0, p1)Set the number of sample points for a planar grid clip.
clip.ijk_axis(p0)Display an axis system for a IJK extract.
clip.ijk_scale(p0)Specify the length of the IJK axis for IJK extracts.
clip.increment(p0)This command has not yet been documented.
clip.length(p0, p1, p2)Clip: length
clip.line(p0, p1, p2, p3)Set an end point for a clip line.
clip.line_1(p0, p1, p2)Clip: line 1
clip.line_2(p0, p1, p2)Clip: line 2
clip.line_nodeid(p0, p1)Create a clip line defined by the two node ids given.
clip.mesh_plane(p0)Set the plane for XYZ or IJK clips
Specify the number of clips, at the specified delta, to create.
clip.origin(p0, p1, p2)Set origin for quadric and revolution clips.
clip.plane(p0, p1, p2, p3)Set a corner for a clip plane.
clip.plane_1(p0, p1, p2)Clip: plane 1
clip.plane_2(p0, p1, p2)Clip: plane 2
clip.plane_3(p0, p1, p2)Clip: plane 3
clip.plane_nodeid(p0, p1, p2)Create a clip plane defined by the three node ids given.
Clip: plane_showsplineqia
clip.point(p0, p1, p2)Defines points for the surface of revolution.
clip.point_distance(p0, p1)Clip: point_distance
Clip: point_distance 1
Clip: point_distance 10
Clip: point_distance 2
Clip: point_distance 3
Clip: point_distance 4
Clip: point_distance 5
Clip: point_distance 6
Clip: point_distance 7
Clip: point_distance 8
Clip: point_distance 9
clip.point_radii(p0, p1)Clip: point_radii
Clip: point_radii 1
Clip: point_radii 10
Clip: point_radii 2
Clip: point_radii 3
Clip: point_radii 4
Clip: point_radii 5
Clip: point_radii 6
Clip: point_radii 7
Clip: point_radii 8
Clip: point_radii 9
clip.points(p0)Clip: points
clip.pts_on_line(p0)Set the number of sample points for a line clip.
Clip: pts_on_spline
clip.radius(p0)Set the radius for a sphere or cylinder clip.
Set the number of points used in the tool of revolution for clipping.
Clip by revolving a 1D part about an axis.
Clip by revolving a 1D part about an axis.
clip.rtz_axis(p0)Specify the axis to be used for RTZ clips.
clip.sample(p0)Clip: sample
clip.sample_step(p0, p1, p2)Clip: sample_step
Sets the target to the default settings for subsequent attribute modifications.
clip.slider_range_ijk(p0, p1)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(p0)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.
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(p0, p1)Set the min/max X/Y/Z extents in the user interface for a clip of constant X/Y/Z.
clip.slider_y(p0, p1)Set the min/max X/Y/Z extents in the user interface for a clip of constant X/Y/Z.
clip.slider_z(p0, p1)Set the min/max X/Y/Z extents in the user interface for a clip of constant X/Y/Z.
clip.spline_id(p0)Clip: spline_id
This command has not yet been documented.
clip.spline_name(p0)This command has not yet been documented.
clip.tool(p0)Set the clipping tool.
clip.type(p0)This command has not yet been documented.
This command has not yet been documented.
clip.value(p0)Specify the constant plane value for XYZ or IJK clips.
Clip: x_max_infinite
Clip: x_min_infinite
Clip: y_max_infinite
Clip: y_min_infinite
Clip: z_max_infinite
Clip: z_min_infinite