FileGDBAPI::MultiPatchShapeBuffer Class Reference

MultiPatch Shape Buffer accessor functions. More...

Inherits FileGDBAPI::ShapeBuffer.

List of all members.

Public Member Functions
fgdbError	GetExtent (double *&extent)
	Get a pointer to the geomtries extent.
fgdbError	GetNumParts (int &numParts)
	Get the number of parts.
fgdbError	GetNumPoints (int &numPoints)
	Get the number of coordinates in the geometry.
fgdbError	GetParts (int *&parts)
	Get a pointer to the parts array.
fgdbError	GetPartDescriptors (int *&partDescriptorArray)
	Get a pointer to the part descriptor array.
fgdbError	GetPoints (Point *&points)
	Get a pointer to the point array.
fgdbError	GetZExtent (double *&zExtent)
	Get a pointer to the z extent.
fgdbError	GetZs (double *&zArray)
	Get a pointer to the z array.
fgdbError	GetMExtent (double *&mExtent)
	Get a pointer to the m extent.
fgdbError	GetMs (double *&mArray)
	Get a pointer to the m array.
fgdbError	GetIDs (int *&ids)
	Get a pointer to the id array.
fgdbError	GetNormals (float *&normals)
	Get a pointer to the normals array.
fgdbError	GetTextures (int &numTextures, int &textureDimension, int *&textureParts, float *&textureCoords)
	Returns textures.
fgdbError	GetMaterials (int &numMaterials, int &compressionType, int *&materialParts, byte *&materials)
	Returns materials.
fgdbError	Setup (ShapeType shapeType, int numParts, int numPoints, int numTextures=0, int textureDimension=0, int numMaterials=0)
	Setup a shape buffer for insert.
fgdbError	CalculateExtent (void)
	Calculates the extent for the shape after all of the coordinate arrays have been filled.

---

Detailed Description

MultiPatch Shape Buffer accessor functions.

These functions provide access to the shape buffer. Consult the extended shapefile format document for the buffer layout.

---

Member Function Documentation

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetExtent

(

double *&

extent

)

Get a pointer to the geomtries extent.

Parameters:

[out]

extent

A pointer to the geometries extent.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetNumParts

(

int &

numParts

)

Get the number of parts.

Parameters:

[out]

numParts

The number of parts in the geometry.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetNumPoints

(

int &

numPoints

)

Get the number of coordinates in the geometry.

Parameters:

[out]

numPoints

The number of points.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetParts

(

int *&

parts

)

Get a pointer to the parts array.

Parameters:

[out]

parts

A pointer to the parts array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetPartDescriptors

(

int *&

partDescriptorArray

)

Get a pointer to the part descriptor array.

Parameters:

[out]

partDescriptorArray

A pointer to the part descriptor array.

Returns:

Error code indicating whether the method finished successfully

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetPoints

(

Point *&

points

)

Get a pointer to the point array.

Parameters:

[out]

points

A pointer to the point array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetZExtent

(

double *&

zExtent

)

Get a pointer to the z extent.

Parameters:

[out]

zExtent

A pointer to the z extent.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetZs

(

double *&

zArray

)

Get a pointer to the z array.

Parameters:

[out]

zArray

A pointer to the z array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetMExtent

(

double *&

mExtent

)

Get a pointer to the m extent.

Parameters:

[out]

mExtent

A pointer to the m extent.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetMs

(

double *&

mArray

)

Get a pointer to the m array.

Parameters:

[out]

mArray

A pointer to the m array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetIDs

(

int *&

ids

)

Get a pointer to the id array.

Parameters:

[out]

ids

A pointer to the id array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetNormals

(

float *&

normals

)

Get a pointer to the normals array.

Parameters:

[out]

normals

A pointer to the normals array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetTextures	(	int &	numTextures,
		int &	textureDimension,
		int *&	textureParts,
		float *&	textureCoords
	)

Returns textures.

Parameters:

[out]	numTextures	The number of textures
[out]	textureDimension	The texture dimension.
[out]	textureParts	A pointer to the texture parts.
[out]	textureCoords	A pointer to the texture coordinates.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::GetMaterials	(	int &	numMaterials,
		int &	compressionType,
		int *&	materialParts,
		byte *&	materials
	)

Returns materials.

Parameters:

[out]	numMaterials	The number of materials
[out]	compressionType	The compression type.
[out]	materialParts	A pointer to the number of material parts.
[out]	materials	A pointer to the materials array.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::Setup	(	ShapeType	shapeType,
		int	numParts,
		int	numPoints,
		int	numTextures = 0,
		int	textureDimension = 0,
		int	numMaterials = 0
	)

Setup a shape buffer for insert.

Allocates the correct length buffer for the selected shape type.

Parameters:

[in]	shapeType	The shape type of the buffer. Shape Type
[in]	numParts	The number of parts that the geometry will contain.
[in]	numPoints	The number of points that the geometry will contain.
[in]	numTextures	The number of textures that the geometry will contain, defaults to zero.
[in]	textureDimension	The textureDimension that the geometry will contain, defaults to zero.
[in]	numMaterials	The number of materials that the geometry will contain, defaults to zero.

Returns:

Error code indicating whether the method finished successfully.

fgdbError FileGDBAPI::MultiPatchShapeBuffer::CalculateExtent

(

void

)

Calculates the extent for the shape after all of the coordinate arrays have been filled.

Returns:

Error code indicating whether the method finished successfully.