GU_LocalFrame.h

Go to the documentation of this file.

/*
* PROPRIETARY INFORMATION.  This software is proprietary to
* Side Effects Software Inc., and is not to be reproduced,
* transmitted, or disclosed in any way without written permission.
*
* NAME:        GU_LocalFrame.h ( GU Library, C++)
*
* COMMENTS:
*      Useful functions for computing local coordinate frames for collections
*      of components.
*/

#ifndef __GU_LocalFrame_h__
#define __GU_LocalFrame_h__

#include "GU_API.h"

#include <GA/GA_Types.h>
#include <GA/GA_Edge.h>
#include <GA/GA_Breakpoint.h>
#include <UT/UT_Function.h>
#include <UT/UT_VectorTypes.h>


class GA_PointGroup;
class GA_PrimitiveGroup;
class GA_EdgeGroup;
class GA_BreakpointGroup;
class GEO_Detail;
class GU_Detail;

namespace GU_LocalFrame
{
    /// Different types of local frames that can be computed for components.
    enum FrameType {
        LOCALFRAME_COMPONENT = 0,
        LOCALFRAME_NMLANDVEC,
        LOCALFRAME_OBB
    };

    /// Different types of local origins that can be computed for components.
    enum OriginType {
        LOCALORIGIN_BBOX = 0
    };

    /// A class wrapping some common parameters to the functions computing
    /// local frames.
    class GU_API ComputeParms
    {
    public:
        FrameType                myFrameType;

        /// Only used when myFrameType == LOCALFRAME_NMLANDVEC.
        UT_Vector3R              myUpVector;

        /// Only used when myFrameType == LOCALFRAME_OBB and computing prim
        /// local frames.  This is only necessary because we need access to
        /// code in the GT library we cannot access directly from GU.  This
        /// should be set to GT_GUHelpers::computePrimCovariance().
        using PrimCovarianceFunc =
            UT_Function<bool(const GU_Detail &gdp,
                               const GA_Range &prim_range,
                               UT_SymMatrix3R &covariance,
                               UT_Vector3R &centroid,
                               UT_Vector3R &avg_normal,
                               UT_Vector3Array *point_positions,
                               GA_OffsetArray *prim_refs)>;

        PrimCovarianceFunc       myPrimCovarianceFunc;
    };

    /// A class representing a local frame.
    class GU_API Frame
    {
        public:
            UT_Matrix3R          myAxisOrient;
            UT_Vector3R          myOrigin;
    };

    /// TODO: Return status flags indicating if something went wrong during
    ///       the computation.  For example, failed to compute a good normal.

    /// Compute the local frames for a list of primitive groupings.
    GU_API void  computePrimLocalFrames(
                                const ComputeParms &parms,
                                const GEO_Detail &gdp,
                                const GA_PrimitiveGroup *prim_group,
                                const GA_OffsetArray &class_prims,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local frames for a list of point groupings.
    GU_API void  computePointLocalFrames(
                                const ComputeParms &parms,
                                const GEO_Detail &gdp,
                                const GA_PointGroup *point_group,
                                const GA_OffsetArray &class_points,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local frames for a list of edge groupings.
    GU_API void  computeEdgeLocalFrames(
                                const ComputeParms &parms,
                                const GEO_Detail &gdp,
                                const GA_EdgeGroup &edge_group,
                                const UT_Array<GA_Edge> &class_edges,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local frames for a list of breakpoint groupings.
    GU_API void  computeBreakpointLocalFrames(
                                const ComputeParms &parms,
                                const GEO_Detail &gdp,
                                const GA_BreakpointGroup *bkpt_group,
                                const UT_Array<GA_Breakpoint> &class_bkpts,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local origins for a list of primitive groupings.
    GU_API void  computePrimLocalOrigins(
                                OriginType origin_type,
                                const GEO_Detail &gdp,
                                const GA_PrimitiveGroup *prim_group,
                                const GA_OffsetArray &class_prims,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local origins for a list of point groupings.
    GU_API void  computePointLocalOrigins(
                                OriginType origin_type,
                                const GEO_Detail &gdp,
                                const GA_PointGroup *point_group,
                                const GA_OffsetArray &class_points,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local origins for a list of edge groupings.
    GU_API void  computeEdgeLocalOrigins(
                                OriginType origin_type,
                                const GEO_Detail &gdp,
                                const GA_EdgeGroup &edge_group,
                                const UT_Array<GA_Edge> &class_edges,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);

    /// Compute the local origins for a list of breakpoint groupings.
    GU_API void  computeBreakpointLocalOrigins(
                                OriginType origin_type,
                                const GEO_Detail &gdp,
                                const GA_BreakpointGroup *bkpt_group,
                                const UT_Array<GA_Breakpoint> &class_bkpts,
                                const UT_ExintArray &class_start_indices,
                                UT_Array<Frame> &class_frames);
}

#endif // __GU_LocalFrame_h__