ConvexHullParameters Struct Reference

Describes the NxParameterized::Interface for 'ConvexHullParameters' : More...

#include <params.h>

List of all members.

Public Attributes
Vec3	vertices[]
	'vertices[]' : Convex hull vertices
Vec3	uniquePlanes[].normal
	'uniquePlanes[].normal' : A plane normal
F32	uniquePlanes[].d
	'uniquePlanes[].d' : A plane displacement
F32	widths[]
	'widths[]' : For each unique plane (see uniquePlanes), this is the width of the convex polytope
U32	edges[]
	'edges[]' : All edges of the convex polytope, stored in a compressed index format
U32	adjacentFaces[]
	'adjacentFaces[]' : Face (plane) indices which are adjacent to each edge in the edges array.
Bounds3	bounds
	'bounds' : The AABB of the convex hull
F32	volume
	'volume' : The volume of the convex hull
U32	uniqueEdgeDirectionCount
	'uniqueEdgeDirectionCount' : The number of unique edge directions
U32	planeCount
	'planeCount' : The total number of faces

---

Detailed Description

Describes the NxParameterized::Interface for 'ConvexHullParameters' :

ConvexHullParameters contains 15 fully qualified names
---------------------------------------------
  1 : ArraySizeName  vertices                  
  2 : Vec3           vertices[]                
  3 : ArraySizeName  uniquePlanes              
  4 : Vec3           uniquePlanes[].normal     
  5 : F32            uniquePlanes[].d          
  6 : ArraySizeName  widths                    
  7 : F32            widths[]                  
  8 : ArraySizeName  edges                     
  9 : U32            edges[]                   
 10 : ArraySizeName  adjacentFaces             
 11 : U32            adjacentFaces[]           
 12 : Bounds3        bounds                    
 13 : F32            volume                    
 14 : U32            uniqueEdgeDirectionCount  
 15 : U32            planeCount                

---

Member Data Documentation

U32 ConvexHullParameters::adjacentFaces[]

'adjacentFaces[]' : Face (plane) indices which are adjacent to each edge in the edges array.

Face (plane) indices which are adjacent to each edge in the edges array. Each 32-bit integer stores the indices of two faces, in the high and low words. The indices refer to the face planes, and will be in the range [0, planeCount). To interpret the indices correctly, see the description of planeCount. If a "dangling edge" is generated, the face index stored in the high word will be 0xFFFF. (Invalid value.)

Bounds3 ConvexHullParameters::bounds

'bounds' : The AABB of the convex hull

The AABB of the convex hull.

U32 ConvexHullParameters::edges[]

'edges[]' : All edges of the convex polytope, stored in a compressed index format

All edges of the convex polytope, stored in a compressed index format. Each 32-bit integer stores the indices of two endpoints, in the high and low words. The indices refer to the vertices array. The edges are stored such that all unique edge directions are represented by the first uniqueEdgeDirectionCount entries.

U32 ConvexHullParameters::planeCount

'planeCount' : The total number of faces

The total number of faces. This includes parallel opposite faces, so may be larger than the array size of uniquePlanes. For plane indices i less than uniquePlanes.size(), simply use uniquePlanes[i] to find the corresponding plane. For plane indicies i in the range [uniquePlanes.size(), planeCount), the uniquePlanes array is arranged such that you obtain the correct plane by starting with the plane p = uniquePlanes[index-uniquePlanes.size()]. Then, add widths[index-uniquePlanes.size()] to the plane displacement p.d, and finally negate both the plane normal p.n and the displacement p.d.

U32 ConvexHullParameters::uniqueEdgeDirectionCount

'uniqueEdgeDirectionCount' : The number of unique edge directions

The number of unique edge directions. The first uniqueEdgeDirectionCount elements of the edges array represent these directions.

F32 ConvexHullParameters::uniquePlanes[].d

'uniquePlanes[].d' : A plane displacement

A plane displacement, defined by the negative of the plane normal dotted with a point in the plane. This plane is used to define convex volumes.

Vec3 ConvexHullParameters::uniquePlanes[].normal

'uniquePlanes[].normal' : A plane normal

A plane normal. This plane is used to define convex volumes.

Vec3 ConvexHullParameters::vertices[]

'vertices[]' : Convex hull vertices

The vertices of a convex polytope.

F32 ConvexHullParameters::volume

'volume' : The volume of the convex hull

The volume of the convex hull.

F32 ConvexHullParameters::widths[]

'widths[]' : For each unique plane (see uniquePlanes), this is the width of the convex polytope

For each unique plane (see uniquePlanes), this is the width of the convex polytope. That is, if an opposing face exists, it is the distance between the faces. If no opposing face exists, it is the maximum distance below the unique plane over all vertices.

---

The documentation for this struct was generated from the following file:

• params.h