Files
ThirdParty-6/ParaView-5.0.1/ParaViewCore/ServerManager/Core/vtkSMInputArrayDomain.cxx

359 lines
9.9 KiB
C++

/*=========================================================================
Program: ParaView
Module: vtkSMInputArrayDomain.cxx
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html 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.
=========================================================================*/
#include "vtkSMInputArrayDomain.h"
#include "vtkObjectFactory.h"
#include "vtkPVArrayInformation.h"
#include "vtkPVDataInformation.h"
#include "vtkPVDataSetAttributesInformation.h"
#include "vtkPVXMLElement.h"
#include "vtkSMSourceProxy.h"
#include "vtkSMUncheckedPropertyHelper.h"
vtkStandardNewMacro(vtkSMInputArrayDomain);
bool vtkSMInputArrayDomain::AutomaticPropertyConversion = false;
//---------------------------------------------------------------------------
static const char* const vtkSMInputArrayDomainAttributeTypes[] = {
"point",
"cell",
"field",
"any-except-field",
"vertex",
"edge",
"row",
"any",
NULL
};
//---------------------------------------------------------------------------
vtkSMInputArrayDomain::vtkSMInputArrayDomain()
{
this->AttributeType = vtkSMInputArrayDomain::ANY_EXCEPT_FIELD;
this->NumberOfComponents = 0;
}
//---------------------------------------------------------------------------
vtkSMInputArrayDomain::~vtkSMInputArrayDomain()
{
}
//---------------------------------------------------------------------------
int vtkSMInputArrayDomain::IsInDomain(vtkSMProperty* property)
{
if (this->IsOptional)
{
return 1;
}
if (!property)
{
return 0;
}
vtkSMUncheckedPropertyHelper helper(property);
for (unsigned int cc=0, max=helper.GetNumberOfElements(); cc < max; cc++)
{
if (!this->IsInDomain(
vtkSMSourceProxy::SafeDownCast(helper.GetAsProxy(cc)),
helper.GetOutputPort(cc)))
{
return 0;
}
}
return (helper.GetNumberOfElements() > 0);
}
//---------------------------------------------------------------------------
int vtkSMInputArrayDomain::IsInDomain(vtkSMSourceProxy* proxy,
unsigned int outputport/*=0*/)
{
if (!proxy)
{
return 0;
}
// Make sure the outputs are created.
proxy->CreateOutputPorts();
vtkPVDataInformation* info = proxy->GetDataInformation(outputport);
if (!info)
{
return 0;
}
int attribute_types_to_try[] =
{
vtkDataObject::POINT,
vtkDataObject::CELL,
vtkDataObject::FIELD,
vtkDataObject::VERTEX,
vtkDataObject::EDGE,
vtkDataObject::ROW,
-1
};
for (int kk=0; attribute_types_to_try[kk] != -1; kk++)
{
int attribute_type = attribute_types_to_try[kk];
// check if attribute_type is acceptable.
if (this->IsAttributeTypeAcceptable(attribute_type))
{
vtkPVDataSetAttributesInformation* dsaInfo =
info->GetAttributeInformation(attribute_types_to_try[kk]);
if (this->HasAcceptableArray(dsaInfo))
{
return 1;
}
}
}
return 0;
}
//----------------------------------------------------------------------------
bool vtkSMInputArrayDomain::IsAttributeTypeAcceptable(
int required_type, int attribute_type, int *acceptable_as_type/*=NULL*/)
{
if (acceptable_as_type)
{
*acceptable_as_type = attribute_type;
}
if (required_type == ANY)
{
return attribute_type == POINT||
attribute_type == CELL||
attribute_type == FIELD ||
attribute_type == EDGE||
attribute_type == VERTEX||
attribute_type == ROW;
}
if (required_type == ANY_EXCEPT_FIELD)
{
// Try out all attribute types except field data sequentially.
int attribute_types_to_try[] =
{
vtkDataObject::POINT,
vtkDataObject::CELL,
vtkDataObject::VERTEX,
vtkDataObject::EDGE,
vtkDataObject::ROW,
-1
};
for (int cc=0; attribute_types_to_try[cc] != -1; ++cc)
{
if (vtkSMInputArrayDomain::IsAttributeTypeAcceptable(
attribute_types_to_try[cc], attribute_type, acceptable_as_type))
{
return true;
}
}
return false;
}
switch (attribute_type)
{
case vtkDataObject::POINT:
if (required_type == POINT)
{
return true;
}
if (required_type == CELL && vtkSMInputArrayDomain::AutomaticPropertyConversion)
{
// this a POINT array, however since AutomaticPropertyConversion is ON,
// this array can is acceptable as a CELL array. In other words, caller
// can pretend this array is a CELL array and VTK pipeline will take care
// of it.
if (acceptable_as_type)
{
*acceptable_as_type = CELL;
}
return true;
}
break;
case vtkDataObject::CELL:
if (required_type == CELL)
{
return true;
}
if (required_type == POINT && vtkSMInputArrayDomain::AutomaticPropertyConversion)
{
// this a CELL array, however since AutomaticPropertyConversion is ON,
// this array can is acceptable as a POINT array. In other words, caller
// can pretend this array is a POINT array and VTK pipeline will take care
// of it.
if (acceptable_as_type)
{
*acceptable_as_type = POINT;
}
return true;
}
break;
default:
break;
}
return required_type == attribute_type;
}
//----------------------------------------------------------------------------
bool vtkSMInputArrayDomain::IsArrayAcceptable(
int required_number_of_components, vtkPVArrayInformation* arrayInfo)
{
if (arrayInfo == NULL)
{
return false;
}
if (
// acceptable if the domain doesn't dictate any component requirements.
required_number_of_components <= 0 ||
// acceptable if the components match those in array
arrayInfo->GetNumberOfComponents() == required_number_of_components ||
// when using automatic property conversion, we support automatic extraction
// of a single component from multi-component arrays. However, we still
// don't support automatic extraction of multiple components, so if the
// filter needs more than 1 component, then the number of components must
// match.
(vtkSMInputArrayDomain::AutomaticPropertyConversion &&
required_number_of_components == 1 &&
arrayInfo->GetNumberOfComponents() > 1))
{
return true;
}
return false;
}
//----------------------------------------------------------------------------
bool vtkSMInputArrayDomain::IsAttributeTypeAcceptable(int attributeType)
{
return vtkSMInputArrayDomain::IsAttributeTypeAcceptable(
this->AttributeType, attributeType, NULL);
}
//----------------------------------------------------------------------------
bool vtkSMInputArrayDomain::HasAcceptableArray(
vtkPVDataSetAttributesInformation* attrInfo)
{
for (int idx=0, num = attrInfo->GetNumberOfArrays(); idx < num; ++idx)
{
vtkPVArrayInformation* arrayInfo = attrInfo->GetArrayInformation(idx);
if (vtkSMInputArrayDomain::IsArrayAcceptable(
this->NumberOfComponents, arrayInfo))
{
return true;
}
}
return false;
}
//---------------------------------------------------------------------------
int vtkSMInputArrayDomain::ReadXMLAttributes(
vtkSMProperty* prop, vtkPVXMLElement* element)
{
this->Superclass::ReadXMLAttributes(prop, element);
if (this->GetRequiredProperty("FieldDataSelection"))
{
vtkWarningMacro(
"vtkSMInputArrayDomain no longer supports required property "
"'FieldDataSelection'. Please update the domain definition.");
}
const char* attribute_type = element->GetAttribute("attribute_type");
if (attribute_type)
{
this->SetAttributeType(attribute_type);
}
int numComponents;
if (element->GetScalarAttribute("number_of_components", &numComponents))
{
numComponents = numComponents < 0? 0 : numComponents;
this->SetNumberOfComponents(numComponents);
}
return 1;
}
//---------------------------------------------------------------------------
const char* vtkSMInputArrayDomain::GetAttributeTypeAsString()
{
if (this->AttributeType < vtkSMInputArrayDomain::NUMBER_OF_ATTRIBUTE_TYPES)
{
return vtkSMInputArrayDomainAttributeTypes[this->AttributeType];
}
return "(invalid)";
}
//---------------------------------------------------------------------------
void vtkSMInputArrayDomain::SetAttributeType(const char* type)
{
if (type == NULL)
{
vtkErrorMacro("No type specified");
return;
}
for (int cc=0; cc < vtkSMInputArrayDomain::NUMBER_OF_ATTRIBUTE_TYPES; ++cc)
{
if (strcmp(type, vtkSMInputArrayDomainAttributeTypes[cc]) == 0)
{
this->SetAttributeType(cc);
return;
}
}
// for old code where none==field.
if (strcmp(type, "none") == 0)
{
this->SetAttributeType(vtkSMInputArrayDomain::FIELD);
return;
}
vtkErrorMacro("Unrecognized attribute type: " << type);
}
//---------------------------------------------------------------------------
void vtkSMInputArrayDomain::SetAutomaticPropertyConversion(bool convert)
{
if ( vtkSMInputArrayDomain::AutomaticPropertyConversion != convert )
{
vtkSMInputArrayDomain::AutomaticPropertyConversion = convert;
}
}
//---------------------------------------------------------------------------
bool vtkSMInputArrayDomain::GetAutomaticPropertyConversion()
{
return vtkSMInputArrayDomain::AutomaticPropertyConversion;
}
//---------------------------------------------------------------------------
void vtkSMInputArrayDomain::PrintSelf(ostream& os, vtkIndent indent)
{
this->Superclass::PrintSelf(os, indent);
os << indent << "NumberOfComponents: " << this->NumberOfComponents << endl;
os << indent << "AttributeType: " << this->AttributeType
<< " (" << this->GetAttributeTypeAsString() << ")" << endl;
}