mirror of
https://gitlab.kitware.com/vtk/vtk-m
synced 2024-10-05 01:49:02 +00:00
Fix documentation for methods from FilterField
MR !3195 moved methods from `FilterField` to `Filter`. Needed to update the documentation to do this as well.
This commit is contained in:
parent
eba02710de
commit
97269b9860
@ -71,29 +71,29 @@ Input Fields
|
||||
Filters that take one or more fields as input have a common set of methods to set the "active" fields to operate on.
|
||||
They might also have custom methods to ease setting the appropriate fields, but these are the base methods.
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::SetActiveField(const std::string&, vtkm::cont::Field::Association)
|
||||
.. doxygenfunction:: vtkm::filter::Filter::SetActiveField(const std::string&, vtkm::cont::Field::Association)
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::SetActiveField(vtkm::IdComponent, const std::string&, vtkm::cont::Field::Association)
|
||||
.. doxygenfunction:: vtkm::filter::Filter::SetActiveField(vtkm::IdComponent, const std::string&, vtkm::cont::Field::Association)
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::GetActiveFieldName
|
||||
.. doxygenfunction:: vtkm::filter::Filter::GetActiveFieldName
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::GetActiveFieldAssociation
|
||||
.. doxygenfunction:: vtkm::filter::Filter::GetActiveFieldAssociation
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::SetActiveCoordinateSystem(vtkm::Id)
|
||||
.. doxygenfunction:: vtkm::filter::Filter::SetActiveCoordinateSystem(vtkm::Id)
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::SetActiveCoordinateSystem(vtkm::IdComponent, vtkm::Id)
|
||||
.. doxygenfunction:: vtkm::filter::Filter::SetActiveCoordinateSystem(vtkm::IdComponent, vtkm::Id)
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::GetActiveCoordinateSystemIndex
|
||||
.. doxygenfunction:: vtkm::filter::Filter::GetActiveCoordinateSystemIndex
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::SetUseCoordinateSystemAsField(bool)
|
||||
.. doxygenfunction:: vtkm::filter::Filter::SetUseCoordinateSystemAsField(bool)
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::SetUseCoordinateSystemAsField(vtkm::IdComponent, bool)
|
||||
.. doxygenfunction:: vtkm::filter::Filter::SetUseCoordinateSystemAsField(vtkm::IdComponent, bool)
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::GetUseCoordinateSystemAsField
|
||||
.. doxygenfunction:: vtkm::filter::Filter::GetUseCoordinateSystemAsField
|
||||
|
||||
.. doxygenfunction:: vtkm::filter::FilterField::GetNumberOfActiveFields
|
||||
.. doxygenfunction:: vtkm::filter::Filter::GetNumberOfActiveFields
|
||||
|
||||
The :func:`vtkm::filter::FilterField::SetActiveField` takes an optional argument that specifies which topological elements the field is associated with (such as points or cells).
|
||||
The :func:`vtkm::filter::Filter::SetActiveField` method takes an optional argument that specifies which topological elements the field is associated with (such as points or cells).
|
||||
The :enum:`vtkm::cont::Field::Association` enumeration is used to select the field association.
|
||||
|
||||
.. load-example:: SetActiveFieldWithAssociation
|
||||
@ -110,8 +110,8 @@ The :enum:`vtkm::cont::Field::Association` enumeration is used to select the fie
|
||||
It is also possible to set the active scalar field as a coordinate system of the data.
|
||||
A coordinate system essentially provides the spatial location of the points of the data and they have a special place in the :class:`vtkm::cont::DataSet` structure.
|
||||
(See :secref:`dataset:Coordinate Systems` for details on coordinate systems.)
|
||||
You can use a coordinate system as the active scalars by calling the :func:`vtkm::filter::FilterField::SetUseCoordinateSystemAsField` method with a true flag.
|
||||
Since a :class:`vtkm::cont::DataSet` can have multiple coordinate systems, you can select the desired coordinate system with :func:`vtkm::filter::FilterField::SetActiveCoordinateSystem`.
|
||||
You can use a coordinate system as the active scalars by calling the :func:`vtkm::filter::Filter::SetUseCoordinateSystemAsField` method with a true flag.
|
||||
Since a :class:`vtkm::cont::DataSet` can have multiple coordinate systems, you can select the desired coordinate system with :func:`vtkm::filter::Filter::SetActiveCoordinateSystem`.
|
||||
(By default, the first coordinate system, index 0, will be used.)
|
||||
|
||||
.. load-example:: SetCoordinateSystem
|
||||
|
Loading…
Reference in New Issue
Block a user