You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
169 lines
4.6 KiB
C++
169 lines
4.6 KiB
C++
/*=========================================================================
|
|
|
|
Program: Visualization Toolkit
|
|
Module: vtkDataArraySelection.h
|
|
|
|
Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
|
|
All rights reserved.
|
|
See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
|
|
|
|
This software is distributed WITHOUT ANY WARRANTY; without even
|
|
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
|
|
PURPOSE. See the above copyright notice for more information.
|
|
|
|
=========================================================================*/
|
|
/**
|
|
* @class vtkDataArraySelection
|
|
* @brief Store on/off settings for data arrays for a vtkSource.
|
|
*
|
|
* vtkDataArraySelection can be used by vtkSource subclasses to store
|
|
* on/off settings for whether each vtkDataArray in its input should
|
|
* be passed in the source's output. This is primarily intended to
|
|
* allow file readers to configure what data arrays are read from the
|
|
* file.
|
|
*/
|
|
|
|
#ifndef vtkDataArraySelection_h
|
|
#define vtkDataArraySelection_h
|
|
|
|
#include "vtkCommonCoreModule.h" // For export macro
|
|
#include "vtkObject.h"
|
|
|
|
class vtkDataArraySelectionInternals;
|
|
|
|
class VTKCOMMONCORE_EXPORT vtkDataArraySelection : public vtkObject
|
|
{
|
|
public:
|
|
vtkTypeMacro(vtkDataArraySelection,vtkObject);
|
|
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
|
|
static vtkDataArraySelection* New();
|
|
|
|
/**
|
|
* Enable the array with the given name. Creates a new entry if
|
|
* none exists.
|
|
*/
|
|
void EnableArray(const char* name);
|
|
|
|
/**
|
|
* Disable the array with the given name. Creates a new entry if
|
|
* none exists.
|
|
*/
|
|
void DisableArray(const char* name);
|
|
|
|
/**
|
|
* Return whether the array with the given name is enabled. If
|
|
* there is no entry, the array is assumed to be disabled.
|
|
*/
|
|
int ArrayIsEnabled(const char* name);
|
|
|
|
/**
|
|
* Return whether the array with the given name exists.
|
|
*/
|
|
int ArrayExists(const char* name);
|
|
|
|
/**
|
|
* Enable all arrays that currently have an entry.
|
|
*/
|
|
void EnableAllArrays();
|
|
|
|
/**
|
|
* Disable all arrays that currently have an entry.
|
|
*/
|
|
void DisableAllArrays();
|
|
|
|
/**
|
|
* Get the number of arrays that currently have an entry.
|
|
*/
|
|
int GetNumberOfArrays();
|
|
|
|
/**
|
|
* Get the number of arrays that are enabled.
|
|
*/
|
|
int GetNumberOfArraysEnabled();
|
|
|
|
/**
|
|
* Get the name of the array entry at the given index.
|
|
*/
|
|
const char* GetArrayName(int index);
|
|
|
|
/**
|
|
* Get an index of the array with the given name.
|
|
*/
|
|
int GetArrayIndex(const char *name);
|
|
|
|
/**
|
|
* Get the index of an array with the given name among those
|
|
* that are enabled. Returns -1 if the array is not enabled.
|
|
*/
|
|
int GetEnabledArrayIndex(const char* name);
|
|
|
|
//@{
|
|
/**
|
|
* Get whether the array at the given index is enabled.
|
|
*/
|
|
int GetArraySetting(const char* name)
|
|
{
|
|
return this->GetArraySetting(this->GetArrayIndex(name));
|
|
}
|
|
int GetArraySetting(int index);
|
|
//@}
|
|
|
|
/**
|
|
* Remove all array entries.
|
|
*/
|
|
void RemoveAllArrays();
|
|
|
|
/**
|
|
* Add to the list of arrays that have entries. For arrays that
|
|
* already have entries, the settings are untouched. For arrays
|
|
* that don't already have an entry, they are assumed to be enabled.
|
|
* This method should be called only by the filter owning this
|
|
* object.
|
|
*/
|
|
int AddArray(const char* name);
|
|
|
|
/**
|
|
* Remove an array setting given its index.
|
|
*/
|
|
void RemoveArrayByIndex(int index);
|
|
|
|
/**
|
|
* Remove an array setting given its name.
|
|
*/
|
|
void RemoveArrayByName(const char* name);
|
|
|
|
//@{
|
|
/**
|
|
* Set the list of arrays that have entries. For arrays that
|
|
* already have entries, the settings are copied. For arrays that
|
|
* don't already have an entry, they are assigned the given default
|
|
* status. If no default status is given, it is assumed to be on.
|
|
* There will be no more entries than the names given. This method
|
|
* should be called only by the filter owning this object. The
|
|
* signature with the default must have a different name due to a
|
|
* bug in the Borland C++ 5.5 compiler.
|
|
*/
|
|
void SetArrays(const char* const* names, int numArrays);
|
|
void SetArraysWithDefault(const char* const* names, int numArrays,
|
|
int defaultStatus);
|
|
//@}
|
|
|
|
/**
|
|
* Copy the selections from the given vtkDataArraySelection instance.
|
|
*/
|
|
void CopySelections(vtkDataArraySelection* selections);
|
|
|
|
protected:
|
|
vtkDataArraySelection();
|
|
~vtkDataArraySelection() VTK_OVERRIDE;
|
|
|
|
// Internal implementation details.
|
|
vtkDataArraySelectionInternals* Internal;
|
|
|
|
private:
|
|
vtkDataArraySelection(const vtkDataArraySelection&) VTK_DELETE_FUNCTION;
|
|
void operator=(const vtkDataArraySelection&) VTK_DELETE_FUNCTION;
|
|
};
|
|
|
|
#endif
|