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.
Tools/Win64/VTK/include/vtk-9.0/vtkGenericVertexAttributeMa...

110 lines
3.1 KiB
C++

/*=========================================================================
Program: Visualization Toolkit
Module: vtkGenericVertexAttributeMapping.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 vtkGenericVertexAttributeMapping
* @brief stores mapping for data arrays to
* generic vertex attributes.
*
* vtkGenericVertexAttributeMapping stores mapping between data arrays and
* generic vertex attributes. It is used by vtkPainterPolyDataMapper to pass the
* mappings to the painter which rendering the attributes.
* @par Thanks:
* Support for generic vertex attributes in VTK was contributed in
* collaboration with Stephane Ploix at EDF.
*/
#ifndef vtkGenericVertexAttributeMapping_h
#define vtkGenericVertexAttributeMapping_h
#include "vtkObject.h"
#include "vtkRenderingCoreModule.h" // For export macro
class VTKRENDERINGCORE_EXPORT vtkGenericVertexAttributeMapping : public vtkObject
{
public:
static vtkGenericVertexAttributeMapping* New();
vtkTypeMacro(vtkGenericVertexAttributeMapping, vtkObject);
void PrintSelf(ostream& os, vtkIndent indent) override;
/**
* Select a data array from the point/cell data
* and map it to a generic vertex attribute.
* Note that indices change when a mapping is added/removed.
*/
void AddMapping(
const char* attributeName, const char* arrayName, int fieldAssociation, int component);
/**
* Select a data array and use it as multitexture texture
* coordinates.
* Note the texture unit parameter should correspond to the texture
* unit set on the texture.
*/
void AddMapping(int unit, const char* arrayName, int fieldAssociation, int component);
/**
* Remove a vertex attribute mapping.
*/
bool RemoveMapping(const char* attributeName);
/**
* Remove all mappings.
*/
void RemoveAllMappings();
/**
* Get number of mappings.
*/
unsigned int GetNumberOfMappings();
/**
* Get the attribute name at the given index.
*/
const char* GetAttributeName(unsigned int index);
/**
* Get the array name at the given index.
*/
const char* GetArrayName(unsigned int index);
/**
* Get the field association at the given index.
*/
int GetFieldAssociation(unsigned int index);
/**
* Get the component no. at the given index.
*/
int GetComponent(unsigned int index);
/**
* Get the component no. at the given index.
*/
int GetTextureUnit(unsigned int index);
protected:
vtkGenericVertexAttributeMapping();
~vtkGenericVertexAttributeMapping() override;
private:
vtkGenericVertexAttributeMapping(const vtkGenericVertexAttributeMapping&) = delete;
void operator=(const vtkGenericVertexAttributeMapping&) = delete;
class vtkInternal;
vtkInternal* Internal;
};
#endif