EvaluateClusterProp erty (Geometry) *

Introduced

5.0

Description

Evaluates the cluster property data at the surface locations defined by the point locator data.

The dimension of the returned array depends on the cluster property type, in the same way as defined in ClusterProperty.

If a point locator doesn't correspond exactly to a component defining a value for the cluster property (for example, sampled point for UVs), then the value will be interpolated between adjacent components. In the case of NurbsSurfaceMesh, the returned values will be smoothed according to the NURBS surface mathematical equation since some properties are defined on control vertices (for example, weight maps) while point locators are defined on the surface.

If a point locator corresponds to a discontinuity in property space, the returned value will be an arbitrary one among the many values corresponding to that location.

Notice that the parent cluster is required in addition to the cluster property even if it is unambiguous to get the parent cluster from the cluster property. The reason is that, in the context of a scripted operator, both the cluster and the cluster property must come from the value of an input port, otherwise evaluation errors will occur.

An example using this method can be found in PointLocatorData object's description.

Scripting Syntax

    Geometry.EvaluateClusterProperty( PointLocators, ParentCluster, ClusterProp, [Indices] )

C# Syntax

    Object Geometry.EvaluateClusterProperty( PointLocatorData in_pPtLocators, Cluster in_pParentCluster, ClusterProperty in_pClusterProperty, Object in_pPointLocatorsIndices );

Parameters

Parameter | Type | Description
PointLocators | PointLocatorData | Point locators to be evaluated.
ParentCluster | Cluster | Parent of the cluster property to be evaluated.
ClusterProp | ClusterProperty | Cluster property to be evaluated.
Indices | 1-dimensional Array | Indices of the point locators to be evaluated (all in not specified).

Return Value

2-dimensional Array

See Also

PointLocatorData | Geometry | Geometry.GetClosestLocations | Geometry.GetClosestLocationsWithinRadius
Geometry.GetRaycastIntersections | Geometry.SetupPointLocatorQueries | Geometry.GetSurfacePointLocatorsFromPoints | Geometry.EvaluatePositions
Geometry.EvaluateNormals | PolygonMesh.GetPolygonIndexArray | PolygonMesh.GetTriangleVertexIndexArray | PolygonMesh.GetTriangleNodeIndexArray
PolygonMesh.GetTriangleWeightArray | PolygonMesh.ConstructPointLocators | NurbsSurfaceMesh.GetSubSurfaceIndexArray | NurbsSurfaceMesh.GetNormalizedUVArray
NurbsSurfaceMesh.ConstructPointLocators |  |  |

Autodesk Softimage v7.5