pyvista.ConeSource

Contents

pyvista.ConeSource#

class ConeSource(
center: VectorLike[float] = (0.0, 0.0, 0.0),
direction: VectorLike[float] = (1.0, 0.0, 0.0),
height: float = 1.0,
radius: float | None = None,
capping: bool = True,
angle: float | None = None,
resolution: int = 6,
)[source]#

Cone source algorithm class.

Parameters:
centersequence[float], default: (0.0, 0.0, 0.0)

Center in [x, y, z]. Axis of the cone passes through this point.

directionsequence[float], default: (1.0, 0.0, 0.0)

Direction vector in [x, y, z]. Orientation vector of the cone.

heightfloat, default: 1.0

Height along the cone in its specified direction.

radiusfloat, optional

Base radius of the cone.

cappingbool, default: True

Enable or disable the capping the base of the cone with a polygon.

anglefloat, optional

The angle in degrees between the axis of the cone and a generatrix.

resolutionint, default: 6

Number of facets used to represent the cone.

Examples

Create a default ConeSource.

>>> import pyvista as pv
>>> source = pv.ConeSource()
>>> source.output.plot(show_edges=True, line_width=5)
../../../_images/pyvista-ConeSource-1_00_00.png

Methods

Attributes

ConeSource.angle

Get the angle in degrees between the axis of the cone and a generatrix.

ConeSource.capping

Enable or disable the capping the base of the cone with a polygon.

ConeSource.center

Get the center in [x, y, z].

ConeSource.direction

Get the direction vector in [x, y, z].

ConeSource.height

Get the height along the cone in its specified direction.

ConeSource.output

Get the output data object for a port on this algorithm.

ConeSource.radius

Get base radius of the cone.

ConeSource.resolution

Get number of points on the circular face of the cone.