Next Previous

Sources/Toolkits/OpenGL/Array/GLUArray.mm

/*

     File: GLUArray.mm

 Abstract:

 Utility toolkit for interleaved array management.

  Version: 1.2

 Disclaimer: IMPORTANT:  This Apple software is supplied to you by Apple

 Inc. ("Apple") in consideration of your agreement to the following

 terms, and your use, installation, modification or redistribution of

 this Apple software constitutes acceptance of these terms.  If you do

 not agree with these terms, please do not use, install, modify or

 redistribute this Apple software.

 In consideration of your agreement to abide by the following terms, and

 subject to these terms, Apple grants you a personal, non-exclusive

 license, under Apple's copyrights in this original Apple software (the

 "Apple Software"), to use, reproduce, modify and redistribute the Apple

 Software, with or without modifications, in source and/or binary forms;

 provided that if you redistribute the Apple Software in its entirety and

 without modifications, you must retain this notice and the following

 text and disclaimers in all such redistributions of the Apple Software.

 Neither the name, trademarks, service marks or logos of Apple Inc. may

 be used to endorse or promote products derived from the Apple Software

 without specific prior written permission from Apple.  Except as

 expressly stated in this notice, no other rights or licenses, express or

 implied, are granted by Apple herein, including but not limited to any

 patent rights that may be infringed by your derivative works or by other

 works in which the Apple Software may be incorporated.

 The Apple Software is provided by Apple on an "AS IS" basis.  APPLE

 MAKES NO WARRANTIES, EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION

 THE IMPLIED WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY AND FITNESS

 FOR A PARTICULAR PURPOSE, REGARDING THE APPLE SOFTWARE OR ITS USE AND

 OPERATION ALONE OR IN COMBINATION WITH YOUR PRODUCTS.

 IN NO EVENT SHALL APPLE BE LIABLE FOR ANY SPECIAL, INDIRECT, INCIDENTAL

 OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF

 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS

 INTERRUPTION) ARISING IN ANY WAY OUT OF THE USE, REPRODUCTION,

 MODIFICATION AND/OR DISTRIBUTION OF THE APPLE SOFTWARE, HOWEVER CAUSED

 AND WHETHER UNDER THEORY OF CONTRACT, TORT (INCLUDING NEGLIGENCE),

 STRICT LIABILITY OR OTHERWISE, EVEN IF APPLE HAS BEEN ADVISED OF THE

 POSSIBILITY OF SUCH DAMAGE.

 Copyright (C) 2014 Apple Inc. All Rights Reserved.

*/

#pragma mark -

#pragma mark Headers

// OpenGL vertices private type

#import "GLUVertices.h"

// OpenGL array header

#import "GLUArray.h"

#pragma mark -

#pragma mark Private - Utilities - Vertices

// Append a to a vertex, positions, texture coordinates, and colors

static void GLUVertexPushback(const GLuint& rIndex,

                              const GLfloat * const pPositions,

                              const GLfloat * const pTexCoords,

                              const GLfloat * const pColors,

                              GLU::ArrayRef pArray)

    const GLfloat *positions = pPositions + rIndex * 2;

    const GLfloat *texcoords = pTexCoords + rIndex * 2;

    const GLfloat *colors    = pColors    + rIndex * 4;

    vector_float2 vPositions = {positions[0], positions[1]};

    vector_float2 vTexCoords = {texcoords[0], texcoords[1]};

    vector_float4 vColors    = {colors[0], colors[1], colors[2], colors[3]};

    pArray->m_Vertices.push_back(GLU::Vertex(vPositions, vTexCoords, vColors));

} //GLUVertexPushback

// Append a to a vertex, positions, texture coordinates, and colors

static void GLUVertexPushback(const GLuint& rIndex,

                              const GLfloat * const pPositions,

                              const GLfloat * const pNormals,

                              const GLfloat * const pTexCoords,

                              const GLfloat * const pColors,

                              GLU::ArrayRef pArray)

    const GLfloat *positions = pPositions + rIndex * 3;

    const GLfloat *texcoords = pTexCoords + rIndex * 3;

    const GLfloat *colors    = pColors    + rIndex * 4;

    vector_float3 vPositions = {positions[0], positions[1], positions[2]};

    vector_float3 vTexCoords = {texcoords[0], texcoords[1], texcoords[2]};

    vector_float4 vColors    = {colors[0], colors[1], colors[2], colors[3]};

    if(pNormals != nullptr)

        const GLfloat *normals = pNormals + rIndex * 3;

        vector_float3 vNormals = {normals[0], normals[1], normals[2]};

        pArray->m_Vertices.push_back(GLU::Vertex(vPositions, vNormals, vTexCoords, vColors));

    } // if

    else

        pArray->m_Vertices.push_back(GLU::Vertex(vPositions, vTexCoords, vColors));

    } // else

} //GLUVertexPushback

#pragma mark -

#pragma mark Public - Constructors

// Create an interleaved array for 2D objects

GLU::ArrayRef GLU::ArrayCreate(const GLuint& rCount,

                               const GLfloat * const pPositions,

                               const GLfloat * const pTexCoords,

                               const GLfloat * const pColors)

    GLU::ArrayRef pArray = NULL;

    if(rCount)

try

            pArray = new GLU::Array;

            GLuint i;

            for(i = 0; i < rCount; ++i)

                GLUVertexPushback(i, pPositions, pTexCoords, pColors, pArray);

            } // for

            pArray->mnDim = 2;

            pArray->mnCount[0] = 2;     // positions

            pArray->mnCount[1] = 0;     // normals

            pArray->mnCount[2] = 2;     // texture coordinates

            pArray->mnCount[3] = 4;     // colors

        } // try

        catch(std::bad_alloc& ba)

            NSLog(@">> ERROR: Failed an OpenGL array reference backing store: \"%s\"", ba.what());

        } // catch

    } // if

    return pArray;

} // ArrayCreate

// Create an interleaved vector for 3D objects

GLU::ArrayRef GLU::ArrayCreate(const GLuint& rCount,

                               const GLfloat * const pPositions,

                               const GLfloat * const pNormals,

                               const GLfloat * const pTexCoords,

                               const GLfloat * const pColors)

    GLU::ArrayRef pArray = NULL;

    if(rCount)

try

            pArray = new GLU::Array;

            GLuint i;

            for(i = 0; i < rCount; ++i)

                GLUVertexPushback(i, pPositions, pNormals, pTexCoords, pColors, pArray);

            } // for

            pArray->mnDim = 3;

            pArray->mnCount[0] = 3;                     // positions

            pArray->mnCount[1] = (pNormals) ? 3 : 0;    // normals

            pArray->mnCount[2] = 3;                     // texture coordinates

            pArray->mnCount[3] = 4;                     // colors

        } // try

        catch(std::bad_alloc& ba)

            NSLog(@">> ERROR: Failed an OpenGL array reference backing store: \"%s\"", ba.what());

        } // catch

    } // if

    return pArray;

} // GLVerticesCreate

// Create an interleaved vector for a quad 2D object

GLU::ArrayRef GLU::ArrayCreateQuad(const GLfloat * const pPositionsSrc,

                                   const GLfloat * const pTexCoordsSrc,

                                   const GLfloat * const pColorsSrc)

    // Default positions

    const GLfloat positions[8] =

        -1.0, -1.0,

        1.0, -1.0,

        1.0,  1.0,

        -1.0,  1.0

};

    const GLfloat *pPositionsDst = (pPositionsSrc != nullptr)

    ? pPositionsDst = pPositionsSrc

    : pPositionsDst = positions;

    // Default positions

    const GLfloat texCoords[8] =

        0.0, 0.0,

        1.0, 0.0,

        1.0, 1.0,

        0.0, 1.0

};

    const GLfloat *texCoordsDst = (pTexCoordsSrc != nullptr)

    ? texCoordsDst = pTexCoordsSrc

    : texCoordsDst = texCoords;

    // Default white color

    const GLfloat colors[16] =

        1.0f, 1.0f, 1.0f, 1.0f,

        1.0f, 1.0f, 1.0f, 1.0f,

        1.0f, 1.0f, 1.0f, 1.0f,

        1.0f, 1.0f, 1.0f, 1.0f

};

    const GLfloat *pColorsDst = (pColorsSrc != nullptr)

    ? pColorsDst = pColorsSrc

    : pColorsDst = colors;

    const GLuint nCount = 4;

    return GLU::ArrayCreate(nCount, pPositionsDst, texCoordsDst, pColorsDst);

} // ArrayCreateQuad

#pragma mark -

#pragma mark Public - Desturctor

// Delete 2D/3D interleaved vector

void GLU::ArrayDelete(GLU::ArrayRef pArray)

    if(pArray != nullptr)

        pArray->m_Vertices.clear();

        delete pArray;

    } // if

} // ArrayDelete

#pragma mark -

#pragma mark Public - Accessors

// The vertex count

const GLuint GLU::ArrayGetCount(const GLU::ArrayRef pArray)

    return pArray->m_Vertices.size();

} // ArrayGetCount

// Accessors for 2D positions in an interleaved array

const vector_float2 GLU::ArrayGetPosition2D(const GLuint& rIndex,

                                            const GLU::ArrayRef pArray)

    vector_float2 position;

    if(pArray->mnDim == 2)

        position = pArray->m_Vertices[rIndex].m_Vertex2D.m_Positions;

    } // if

    else

        vector_float3 position3D = (pArray->mnCount[1])

        ? pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_2.m_Positions

        : pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_1.m_Positions;

        position.x = position3D.x;

        position.y = position3D.y;

    } // else

    return position;

} // ArrayGetPosition2D

// Accessors for 2D texture coordinates in an interleaved array

const vector_float2 GLU::ArrayGetTexCoords2D(const GLuint& rIndex,

                                             const GLU::ArrayRef pArray)

    vector_float2 texcoords;

    if(pArray->mnDim == 2)

        texcoords = pArray->m_Vertices[rIndex].m_Vertex2D.m_Texcoords;

    } // if

    else

        vector_float3 texcoords3D = (pArray->mnCount[1])

        ? pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_2.m_Texcoords

        : pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_1.m_Texcoords;

        texcoords.x = texcoords3D.x;

        texcoords.y = texcoords3D.y;

    } // else

    return texcoords;

} // ArrayGetTexCoords2D

// Accessors for 3D position in an interleaved array

const vector_float3 GLU::ArrayGetPosition3D(const GLuint& rIndex,

                                            const GLU::ArrayRef pArray)

    vector_float3 position;

    if(pArray->mnDim == 3)

        position = (pArray->mnCount[1])

        ? pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_2.m_Positions

        : pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_1.m_Positions;

    } // if

    else

        vector_float2 position2D = pArray->m_Vertices[rIndex].m_Vertex2D.m_Positions;

        position.x = position2D.x;

        position.y = position2D.y;

        position.z = 0.0f;

    } // else

    return position;

} // ArrayGetPosition3D

// Accessors for 3D normals in an interleaved array

const vector_float3 GLU::ArrayGetNormals3D(const GLuint& rIndex,

                                           const GLU::ArrayRef pArray)

    vector_float3 normals = {-1.0f,-1.0f,-1.0f};

    if((pArray->mnDim == 3) && (pArray->mnCount[1] == 3))

        normals = pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_2.m_Normals;

    } // if

    return normals;

} // ArrayGetNormals3D

// Accessors for 3D texture coordinates in an interleaved array

const vector_float3 GLU::ArrayGetTexCoords3D(const GLuint& rIndex,

                                             const ArrayRef pArray)

    vector_float3 texcoords;

    if(pArray->mnDim == 3)

        texcoords = (pArray->mnCount[1])

        ? pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_2.m_Texcoords

        : pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_1.m_Texcoords;

    } // if

    else

        vector_float2 texcoords2D = pArray->m_Vertices[rIndex].m_Vertex2D.m_Texcoords;

        texcoords.x = texcoords2D.x;

        texcoords.y = texcoords2D.y;

        texcoords.z = 0.0f;

    } // else

    return texcoords;

} // ArrayGetTexCoords3D

// Accessors for vertex color in an interleaved array

const vector_float4 GLU::ArrayGetColors(const GLuint& rIndex,

                                        const GLU::ArrayRef pArray)

    vector_float4 colors;

    if(pArray->mnDim == 2)

        colors = pArray->m_Vertices[rIndex].m_Vertex2D.m_Colors;

    } // if

    else

        colors = (pArray->mnCount[1])

        ? pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_2.m_Colors

        : pArray->m_Vertices[rIndex].m_Vertex3D.m_v3D_1.m_Colors;

    } // else

    return colors;

} // ArrayGetColors

Next Previous