Main Page   Modules   Alphabetical List   Data Structures   Data Fields  

RtWorldImportPartitionIterators
[RtWorldImport]


Functions

RwBool RtWorldImportHintBBoxPartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)
RwBool RtWorldImportHighestVertexAccommodatingPlanePartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)
RwBool RtWorldImportOrthogonalAutoPartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)
RwBool RtWorldImportRegularIntervalPartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)
RwBool RtWorldImportMedianPercentagePartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)
RwBool RtWorldImportMiddleAxisPartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)
RwBool RtWorldImportMaterialBoundsPartitionIterator (RtWorldImportBuildSector *buildSector, RtWorldImportBuildStatus *buildStatus, RtWorldImportPartition *partition, void *userData, RwInt32 *loopCounter)

Detailed Description

The set of provided RtWorldImportPartitionIterators: Iterates through a set of candidate partitions, possibly using the geometric information in the build sector, or perhaps using some other criteria.

Function Documentation

RwBool RtWorldImportHighestVertexAccommodatingPlanePartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportHighestVertexAccommodatingPlanePartitionIterator iterates through all partitions that pass through the highest point in the sector.

Note:
The highest point returned may be located on a plane of the sector's bounding box, but it cannot be on all three planes, i.e. a corner. This is considered out of bounds so that at least one of the three candidate partitions (x, y, or z) is not peripheral.
Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  NULL.
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if found.

RwBool RtWorldImportHintBBoxPartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportHintBBoxPartitionIterator iterates though all partitions that are coincident with a face of a bounding box from the hints

Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  NULL. (Can be passed an RwReal which takes on the strength value of the partition hint.)
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if found.

RwBool RtWorldImportMaterialBoundsPartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportMaterialBoundsPartitionIterator iterates through all material bounds in a world sector. This is useful for grouping materials into the same sectors.

Note:
This implementation assumes that matIndex < buildSector->maxNumMaterials
Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  NULL.
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if successful, FALSE otherwise

RwBool RtWorldImportMedianPercentagePartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportMedianPercentagePartitionIterator iterates through a number of partitions that are located towards the centre of the population of the sector.

Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  A pointer to an RwInt32 that is the number of partitions per axis.
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if successful, FALSE otherwise

RwBool RtWorldImportMiddleAxisPartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportMiddleAxisPartitionIterator iterates through all partitions that are in the middle of the sector, (one for each axis).

Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  NULL.
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if successful, FALSE if there is an error

RwBool RtWorldImportOrthogonalAutoPartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportOrthogonalAutoPartitionIterator iterates through all partitions that are defined by the plane of each triangle in the scene, if and only if it is orthogonal.

Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  NULL.
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if found.

RwBool RtWorldImportRegularIntervalPartitionIterator (  RtWorldImportBuildSector *    buildSector,
RtWorldImportBuildStatus *    buildStatus,
RtWorldImportPartition *    partition,
void *    userData,
RwInt32 *    loopCounter
) 
 

RtWorldImportRegularIntervalPartitionIterator iterates through all partitions that are equally spaced along each of the axes. The number is in the userData.

Parameters:
buildSector  A pointer to the Build Sector.
buildStatus  A pointer to the Build Status.
partition  A pointer to the partition that is found.
userData  A pointer to an RwInt32 that is the number of partitions per axis.
loopCounter  A pointer to the number of iterations thus far.
Returns:
TRUE if found.

Criterion Software © 1993-2004 Criterion Software Limited. All rights reserved. Built Thu Feb 12 13:47:12 2004. Send Feedback