# encoding: utf-8
# module vtkmodules.vtkCommonExecutionModel
# from C:\Users\xukai\Downloads\发票2\venv\Lib\site-packages\vtkmodules\vtkCommonExecutionModel.cp311-win_amd64.pyd
# by generator 1.147
# no doc

# imports
import vtkmodules.vtkCommonCore as __vtkmodules_vtkCommonCore


class vtkScalarTree(__vtkmodules_vtkCommonCore.vtkObject):
    """
    vtkScalarTree - organize data according to scalar values (used to
    accelerate contouring operations)
    
    Superclass: vtkObject
    
    vtkScalarTree is an abstract class that defines the API to concrete
    scalar tree subclasses. A scalar tree is a data structure that
    organizes data according to its scalar value. This allows rapid
    access to data for those algorithms that access the data based on
    scalar value. For example, isocontouring operates on cells based on
    the scalar (isocontour) value.
    
    To use subclasses of this class, you must specify a dataset to
    operate on, and then specify a scalar value in the InitTraversal()
    method. Then calls to GetNextCell() return cells whose scalar data
    contains the scalar value specified. (This describes serial
    traversal.)
    
    Methods supporting parallel traversal (such as threading) are also
    supported. Basically thread-safe batches of cells (which are a
    portion of the whole dataset) are available for processing using a
    parallel For() operation. First request the number of batches, and
    then for each batch, retrieve the array of cell ids in that batch.
    These batches contain cell ids that are likely to contain the
    isosurface.
    
    @sa
    vtkSimpleScalarTree vtkSpanSpace
    """
    def BuildTree(self): # real signature unknown; restored from __doc__
        """
        BuildTree(self) -> None
        C++: virtual void BuildTree()
        
        Construct the scalar tree from the dataset provided. Checks build
        times and modified time from input and reconstructs the tree if
        necessary.
        """
        pass

    def GetCellBatch(self, batchNum, numCells): # real signature unknown; restored from __doc__
        """
        GetCellBatch(self, batchNum:int, numCells:int) -> Pointer
        C++: virtual const vtkIdType *GetCellBatch(vtkIdType batchNum,
            vtkIdType &numCells)
        
        Return the array of cell ids in the specified batch. The method
        also returns the number of cell ids in the array. Make sure to
        call GetNumberOfCellBatches() beforehand.
        """
        pass

    def GetDataSet(self): # real signature unknown; restored from __doc__
        """
        GetDataSet(self) -> vtkDataSet
        C++: virtual vtkDataSet *GetDataSet()
        """
        pass

    def GetNumberOfCellBatches(self, scalarValue): # real signature unknown; restored from __doc__
        """
        GetNumberOfCellBatches(self, scalarValue:float) -> int
        C++: virtual vtkIdType GetNumberOfCellBatches(double scalarValue)
        
        Get the number of cell batches available for processing as a
        function of the specified scalar value. Each batch contains a
        list of candidate cells that may contain the specified isocontour
        value.
        """
        return 0

    def GetNumberOfGenerationsFromBase(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBase(self, type:str) -> int
        C++: vtkIdType GetNumberOfGenerationsFromBase(const char *type)
            override;
        
        Given the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetNumberOfGenerationsFromBaseType(self, type): # real signature unknown; restored from __doc__
        """
        GetNumberOfGenerationsFromBaseType(type:str) -> int
        C++: static vtkIdType GetNumberOfGenerationsFromBaseType(
            const char *type)
        
        Given a the name of a base class of this class type, return the
        distance of inheritance between this class type and the named
        class (how many generations of inheritance are there between this
        class and the named class). If the named class is not in this
        class's inheritance tree, return a negative value. Valid
        responses will always be nonnegative. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def GetScalars(self): # real signature unknown; restored from __doc__
        """
        GetScalars(self) -> vtkDataArray
        C++: virtual vtkDataArray *GetScalars()
        """
        pass

    def GetScalarValue(self): # real signature unknown; restored from __doc__
        """
        GetScalarValue(self) -> float
        C++: double GetScalarValue()
        
        Return the current scalar value over which tree traversal is
        proceeding. This is the scalar value provided in InitTraversal().
        """
        return 0.0

    def Initialize(self): # real signature unknown; restored from __doc__
        """
        Initialize(self) -> None
        C++: virtual void Initialize()
        
        Initialize locator. Frees memory and resets object as
        appropriate.
        """
        pass

    def InitTraversal(self, scalarValue): # real signature unknown; restored from __doc__
        """
        InitTraversal(self, scalarValue:float) -> None
        C++: virtual void InitTraversal(double scalarValue)
        
        Begin to traverse the cells based on a scalar value (serial
        traversal). Returned cells will have scalar values that span the
        scalar value specified. Note that changing the scalarValue does
        not cause the scalar tree to be modified, and hence it does not
        rebuild.
        """
        pass

    def IsA(self, type): # real signature unknown; restored from __doc__
        """
        IsA(self, type:str) -> int
        C++: vtkTypeBool IsA(const char *type) override;
        
        Return 1 if this class is the same type of (or a subclass of) the
        named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def IsTypeOf(self, type): # real signature unknown; restored from __doc__
        """
        IsTypeOf(type:str) -> int
        C++: static vtkTypeBool IsTypeOf(const char *type)
        
        Return 1 if this class type is the same type of (or a subclass
        of) the named class. Returns 0 otherwise. This method works in
        combination with vtkTypeMacro found in vtkSetGet.h.
        """
        return 0

    def NewInstance(self): # real signature unknown; restored from __doc__
        """
        NewInstance(self) -> vtkScalarTree
        C++: vtkScalarTree *NewInstance()
        """
        return vtkScalarTree

    def SafeDownCast(self, o): # real signature unknown; restored from __doc__
        """
        SafeDownCast(o:vtkObjectBase) -> vtkScalarTree
        C++: static vtkScalarTree *SafeDownCast(vtkObjectBase *o)
        """
        return vtkScalarTree

    def SetDataSet(self, __a): # real signature unknown; restored from __doc__
        """
        SetDataSet(self, __a:vtkDataSet) -> None
        C++: virtual void SetDataSet(vtkDataSet *)
        
        Build the tree from the points/cells and scalars defining this
        dataset.
        """
        pass

    def SetScalars(self, __a): # real signature unknown; restored from __doc__
        """
        SetScalars(self, __a:vtkDataArray) -> None
        C++: virtual void SetScalars(vtkDataArray *)
        
        Build the tree from the points/cells and scalars defining the
        dataset and scalars provided. Typically the scalars come from the
        vtkDataSet specified, but sometimes a separate vtkDataArray is
        provided to specify the scalars. If the scalar array is
        explicitly set, then it takes precedence over the scalars held in
        the vtkDataSet.
        """
        pass

    def ShallowCopy(self, stree): # real signature unknown; restored from __doc__
        """
        ShallowCopy(self, stree:vtkScalarTree) -> None
        C++: virtual void ShallowCopy(vtkScalarTree *stree)
        
        This method is used to copy data members when cloning an instance
        of the class. It does not copy heavy data.
        """
        pass

    def __delattr__(self, *args, **kwargs): # real signature unknown
        """ Implement delattr(self, name). """
        pass

    def __getattribute__(self, *args, **kwargs): # real signature unknown
        """ Return getattr(self, name). """
        pass

    def __init__(self, *args, **kwargs): # real signature unknown
        pass

    @staticmethod # known case of __new__
    def __new__(*args, **kwargs): # real signature unknown
        """ Create and return a new object.  See help(type) for accurate signature. """
        pass

    def __repr__(self, *args, **kwargs): # real signature unknown
        """ Return repr(self). """
        pass

    def __setattr__(self, *args, **kwargs): # real signature unknown
        """ Implement setattr(self, name, value). """
        pass

    def __str__(self, *args, **kwargs): # real signature unknown
        """ Return str(self). """
        pass

    __this__ = property(lambda self: object(), lambda self, v: None, lambda self: None)  # default
    """Pointer to the C++ object."""


    __dict__ = None # (!) real value is "mappingproxy({'__vtkname__': 'vtkScalarTree', 'IsTypeOf': <method 'IsTypeOf' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'IsA': <method 'IsA' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'SafeDownCast': <method 'SafeDownCast' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'NewInstance': <method 'NewInstance' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetNumberOfGenerationsFromBaseType': <method 'GetNumberOfGenerationsFromBaseType' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetNumberOfGenerationsFromBase': <method 'GetNumberOfGenerationsFromBase' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'ShallowCopy': <method 'ShallowCopy' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'SetDataSet': <method 'SetDataSet' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetDataSet': <method 'GetDataSet' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'SetScalars': <method 'SetScalars' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetScalars': <method 'GetScalars' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'BuildTree': <method 'BuildTree' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'Initialize': <method 'Initialize' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'InitTraversal': <method 'InitTraversal' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetScalarValue': <method 'GetScalarValue' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetNumberOfCellBatches': <method 'GetNumberOfCellBatches' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, 'GetCellBatch': <method 'GetCellBatch' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__new__': <built-in method __new__ of type object at 0x00007FF82F4E8670>, '__repr__': <slot wrapper '__repr__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__str__': <slot wrapper '__str__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__getattribute__': <slot wrapper '__getattribute__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__setattr__': <slot wrapper '__setattr__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__delattr__': <slot wrapper '__delattr__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__dict__': <attribute '__dict__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__this__': <attribute '__this__' of 'vtkmodules.vtkCommonExecutionModel.vtkScalarTree' objects>, '__doc__': 'vtkScalarTree - organize data according to scalar values (used to\\naccelerate contouring operations)\\n\\nSuperclass: vtkObject\\n\\nvtkScalarTree is an abstract class that defines the API to concrete\\nscalar tree subclasses. A scalar tree is a data structure that\\norganizes data according to its scalar value. This allows rapid\\naccess to data for those algorithms that access the data based on\\nscalar value. For example, isocontouring operates on cells based on\\nthe scalar (isocontour) value.\\n\\nTo use subclasses of this class, you must specify a dataset to\\noperate on, and then specify a scalar value in the InitTraversal()\\nmethod. Then calls to GetNextCell() return cells whose scalar data\\ncontains the scalar value specified. (This describes serial\\ntraversal.)\\n\\nMethods supporting parallel traversal (such as threading) are also\\nsupported. Basically thread-safe batches of cells (which are a\\nportion of the whole dataset) are available for processing using a\\nparallel For() operation. First request the number of batches, and\\nthen for each batch, retrieve the array of cell ids in that batch.\\nThese batches contain cell ids that are likely to contain the\\nisosurface.\\n\\n@sa\\nvtkSimpleScalarTree vtkSpanSpace\\n\\n'})"
    __vtkname__ = 'vtkScalarTree'


