class_docstr: An internal class to manage filters/algorithms for polydata datasets.
class_docstr_tok: ["An","internal","class","to","manage","filters\/algorithms","for","polydata","datasets","."]
docstr: Sweep polygonal data creating a "skirt" from free edges.
  
  This will create a line from vertices.
  
  This takes polygonal data as input and generates polygonal
  data on output. The input dataset is swept according to some
  extrusion function and creates new polygonal primitives. These
  primitives form a "skirt" or swept surface. For example,
  sweeping a line results in a quadrilateral, and sweeping a
  triangle creates a "wedge".
  
  The skirt is generated by locating certain topological
  features. Free edges (edges of polygons or triangle strips
  only used by one polygon or triangle strips) generate
  surfaces. This is true also of lines or polylines. Vertices
  generate lines.
  
  .. versionchanged:: 0.32.0
     The ``capping`` keyword was added with a default of ``False``.
     The previously used VTK default corresponds to ``capping=True``.
     In a future version the default will be changed to ``True`` to
     match the behavior of the underlying VTK filter.
  
  Parameters
  ----------
  vector : numpy.ndarray or sequence
      Direction and length to extrude the mesh in.
  
  capping : bool, optional
      Control if the sweep of a 2D object is capped. The default is
      ``False``, which differs from VTK's default.
  
      .. warning::
         The ``capping`` keyword was added in version 0.32.0 with a
         default value of ``False``. In a future version this default
         will be changed to ``True`` to match the behavior of the
         underlying VTK filter. It is recommended to explicitly pass
         a value for this keyword argument to prevent future changes
         in behavior and warnings.
  
  inplace : bool, default: False
      Overwrites the original mesh in-place.
  
  progress_bar : bool, default: False
      Display a progress bar to indicate progress.
  
  Returns
  -------
  pyvista.PolyData
      Extruded mesh.
  
  Examples
  --------
  Extrude a half circle arc.
  
  >>> import pyvista as pv
  >>> arc = pv.CircularArc([-1, 0, 0], [1, 0, 0], [0, 0, 0])
  >>> mesh = arc.extrude([0, 0, 1], capping=False)
  >>> mesh.plot(color='lightblue')
  
  Extrude and cap an 8 sided polygon.
  
  >>> poly = pv.Polygon(n_sides=8)
  >>> mesh = poly.extrude((0, 0, 1.5), capping=True)
  >>> mesh.plot(line_width=5, show_edges=True)
docstr_tok: ["Sweep","polygonal","data","creating","a","``","skirt","''","from","free","edges",".","This","will","create","a","line","from","vertices",".","This","takes","polygonal","data","as","input","and","generates","polygonal","data","on","output",".","The","input","dataset","is","swept","according","to","some","extrusion","function","and","creates","new","polygonal","primitives",".","These","primitives","form","a","``","skirt","''","or","swept","surface",".","For","example",",","sweeping","a","line","results","in","a","quadrilateral",",","and","sweeping","a","triangle","creates","a","``","wedge","''",".","The","skirt","is","generated","by","locating","certain","topological","features",".","Free","edges","(","edges","of","polygons","or","triangle","strips","only","used","by","one","polygon","or","triangle","strips",")","generate","surfaces",".","This","is","true","also","of","lines","or","polylines",".","Vertices","generate","lines",".","..","versionchanged",":",":","0.32.0","The","``","capping","``","keyword","was","added","with","a","default","of","``","False","``",".","The","previously","used","VTK","default","corresponds","to","``","capping=True","``",".","In","a","future","version","the","default","will","be","changed","to","``","True","``","to","match","the","behavior","of","the","underlying","VTK","filter",".","Parameters","--","--","--","--","--","vector",":","numpy.ndarray","or","sequence","Direction","and","length","to","extrude","the","mesh","in",".","capping",":","bool",",","optional","Control","if","the","sweep","of","a","2D","object","is","capped",".","The","default","is","``","False","``",",","which","differs","from","VTK","'s","default",".","..","warning",":",":","The","``","capping","``","keyword","was","added","in","version","0.32.0","with","a","default","value","of","``","False","``",".","In","a","future","version","this","default","will","be","changed","to","``","True","``","to","match","the","behavior","of","the","underlying","VTK","filter",".","It","is","recommended","to","explicitly","pass","a","value","for","this","keyword","argument","to","prevent","future","changes","in","behavior","and","warnings",".","inplace",":","bool",",","default",":","False","Overwrites","the","original","mesh","in-place",".","progress_bar",":","bool",",","default",":","False","Display","a","progress","bar","to","indicate","progress",".","Returns","--","--","--","-","pyvista.PolyData","Extruded","mesh",".","Examples","--","--","--","--","Extrude","a","half","circle","arc",".",">",">",">","import","pyvista","as","pv",">",">",">","arc","=","pv.CircularArc","(","[","-1",",","0",",","0","]",",","[","1",",","0",",","0","]",",","[","0",",","0",",","0","]",")",">",">",">","mesh","=","arc.extrude","(","[","0",",","0",",","1","]",",","capping=False",")",">",">",">","mesh.plot","(","color='lightblue","'",")","Extrude","and","cap","an","8","sided","polygon",".",">",">",">","poly","=","pv.Polygon","(","n_sides=8",")",">",">",">","mesh","=","poly.extrude","(","(","0",",","0",",","1.5",")",",","capping=True",")",">",">",">","mesh.plot","(","line_width=5",",","show_edges=True",")"]
code: def extrude(
      self, vector, capping=None, inplace=False, progress_bar=False
  ):
      """Sweep polygonal data creating a "skirt" from free edges.
  
      This will create a line from vertices.
  
      This takes polygonal data as input and generates polygonal
      data on output. The input dataset is swept according to some
      extrusion function and creates new polygonal primitives. These
      primitives form a "skirt" or swept surface. For example,
      sweeping a line results in a quadrilateral, and sweeping a
      triangle creates a "wedge".
  
      The skirt is generated by locating certain topological
      features. Free edges (edges of polygons or triangle strips
      only used by one polygon or triangle strips) generate
      surfaces. This is true also of lines or polylines. Vertices
      generate lines.
  
      .. versionchanged:: 0.32.0
         The ``capping`` keyword was added with a default of ``False``.
         The previously used VTK default corresponds to ``capping=True``.
         In a future version the default will be changed to ``True`` to
         match the behavior of the underlying VTK filter.
  
      Parameters
      ----------
      vector : numpy.ndarray or sequence
          Direction and length to extrude the mesh in.
  
      capping : bool, optional
          Control if the sweep of a 2D object is capped. The default is
          ``False``, which differs from VTK's default.
  
          .. warning::
             The ``capping`` keyword was added in version 0.32.0 with a
             default value of ``False``. In a future version this default
             will be changed to ``True`` to match the behavior of the
             underlying VTK filter. It is recommended to explicitly pass
             a value for this keyword argument to prevent future changes
             in behavior and warnings.
  
      inplace : bool, default: False
          Overwrites the original mesh in-place.
  
      progress_bar : bool, default: False
          Display a progress bar to indicate progress.
  
      Returns
      -------
      pyvista.PolyData
          Extruded mesh.
  
      Examples
      --------
      Extrude a half circle arc.
  
      >>> import pyvista as pv
      >>> arc = pv.CircularArc([-1, 0, 0], [1, 0, 0], [0, 0, 0])
      >>> mesh = arc.extrude([0, 0, 1], capping=False)
      >>> mesh.plot(color='lightblue')
  
      Extrude and cap an 8 sided polygon.
  
      >>> poly = pv.Polygon(n_sides=8)
      >>> mesh = poly.extrude((0, 0, 1.5), capping=True)
      >>> mesh.plot(line_width=5, show_edges=True)
  
      """
      if capping is None:
          capping = False
          warnings.warn(
              "The default value of the ``capping`` keyword argument will change in "
              "a future version to ``True`` to match the behavior of VTK. We recommend "
              "passing the keyword explicitly to prevent future surprises.",
              PyVistaFutureWarning,
          )
  
      alg = _vtk.vtkLinearExtrusionFilter()
      alg.SetExtrusionTypeToVectorExtrusion()
      alg.SetVector(*vector)
      alg.SetInputData(self)
      alg.SetCapping(capping)
      _update_alg(alg, progress_bar, "Extruding")
      output = _get_output(alg)
      if inplace:
          self.copy_from(output, deep=False)
          return self
      return output
  
imports: import collections.abc
  import warnings
  import numpy
  import pyvista
  from pyvista.core import _vtk_core
  from pyvista.core.errors import MissingDataError, NotAllTrianglesError, PyVistaFutureWarning, VTKVersionError
  from pyvista.core.filters import _get_output, _update_alg
  from pyvista.core.filters.data_set import DataSetFilters
  from pyvista.core.utilities.arrays import FieldAssociation, get_array, get_array_association, set_default_active_scalars, vtk_id_list_to_array
  from pyvista.core.utilities.geometric_objects import NORMALS
  from pyvista.core.utilities.helpers import generate_plane, wrap
  from pyvista.core.utilities.misc import abstract_class, assert_empty_kwargs
label_desc: Use image node_id 37 for calling the PolyDataFilters obj's underlying member method code with example usage: obj.extrude(vector, capping, inplace, progress_bar) and returns: output, self