PathEngine home previous: iContentChunk::instantiate()next: iContentChunk::numberOfConnectingEdges()
Contents, API Reference, Interfaces, iContentChunk, instantiate_FloatRotateAndScale

iContentChunk::instantiate_FloatRotateAndScale()

Description

Used to place instances of content chunk geometry into the world.
The instance objects generated can then be used to drive PathEngine's content processing functionality, and to place anchors and shapes against the resulting ground mesh.

Syntax

iContentChunkInstance* instantiate_FloatRotateAndScale(float rotation, float scale, int32_t translationX, int32_t translationY, float translationZ, int32_t sectionID);

Parameters

rotation Orientation of the instantiated geometry in radians, specifying a clockwize rotation around the z axis when looking down that axis from above.
scaleFloating point scale factor.
translationXX origin for the instantiated geometry.
translationYY origin for the instantiated geometry.
translationZZ origin for the instantiated geometry.
sectionID If any value other than -1 is given for this parameter then the sectionID attribute for all faces in the resulting instance's ground geometry will be set to this value (overriding any attributes in the original ground geometry).
Set this parameter to -1 if you wish the sectionID attributed in the original geometry to be passed through unchanged.

Return Value

A pointer to a lightweight API object to represent an instance of this content chunk at the specific position and orientation.

Remarks

The instance objects generated are implemented in terms of references back to the base content chunk geometry, and are therefore very lightweight.

This method provides flexible rotation and scaling but the implication of this flexibility is that content chunks cannot be effectively pre-validated on creation.
If pre-validition is desired then iContentChunk::instantiate() should be used instead.

The created Interface iContentChunkInstance can be explicitly deleted when no longer required, but will also be deleted when this content chunk is released. In either case the pointer to the API object can no longer be used.

C# Mapping

ContentChunkInstance instantiate_FloatRotateAndScale(float rotation, float scale, int translationX, int translationY, float translationZ, int sectionID);

Java Mapping

ContentChunkInstance instantiate_FloatRotateAndScale(float rotation, float scale, int translationX, int translationY, float translationZ, int sectionID);

Documentation for PathEngine release 6.00 - Copyright © 2002-2016 PathEnginenext: iContentChunk::numberOfConnectingEdges()