SIM/SIM_GeometryCopy.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.
 *
 * Produced by:
 *      Side Effects Software Inc.
 *      477 Richmond Street West, Suite 1001
 *      Toronto, Ontario
 *      Canada   M5V 3E7
 *      416-504-9876
 */

#ifndef __SIM_GeometryCopy_h__
#define __SIM_GeometryCopy_h__

#include "SIM_API.h"
#include <UT/UT_DMatrix4.h>
#include "SIM_Geometry.h"

/// This implements a SIM_Geometry that copies the source geometry.
class SIM_API SIM_GeometryCopy : public SIM_Geometry
{
public:
    /// This method provides access to the internal geometry so that it
    /// can be modified. For each call to lockGeometry(), there must be a
    /// corresponding call to releaseGeometry(). Calls to lockGeomtry()
    /// can be nested.
    GU_DetailHandle      lockGeometry();
    /// This function releases the lock on our internal geometry. This
    /// function must be called once for each call to lockGeometry(). Also,
    /// once this function has been called, no more modifications should be
    /// made to the geometry returned by lockGeometry() or the result will
    /// be undefined.
    void                 releaseGeometry();
    /// This method provides access to the internal transform so that it
    /// can be modified. For each call to lockTransform(), there must be a
    /// corresponding call to releaseTransform(). Calls to lockTransform()
    /// can be nested.
    UT_DMatrix4         &lockTransform();
    /// This function releases the lock on our internal transform. This
    /// function must be called once for each call to lockTransform(). Also,
    /// once this function has been called, no more modifications should be
    /// made to the transform returned by lockTransform() or the result will
    /// be undefined.
    void                 releaseTransform();

protected:
    explicit             SIM_GeometryCopy(const SIM_DataFactory *factory);
    virtual             ~SIM_GeometryCopy();

    /// Initializes this data by clearing our internal geometry and transform.
    virtual void         initializeSubclass();
    /// This function creates an internal copy of any SIM_Geometry data
    /// passed to it.
    virtual void         makeEqualSubclass(const SIM_Data *source);
    /// Respond to setting our parameters by adjusting our transform.
    /// The parameters will be in the standard t, r, s style which we
    /// convert in to a matrix and multiply by our current transform.
    virtual void         setParametersSubclass(const SIM_Options &options);

private:
    static const SIM_DopDescription     *getGeometryCopyDopDescription();

    int                                  myDetailLockCount;
    int                                  myTransformLockCount;

    DECLARE_STANDARD_GETCASTTOTYPE();
    DECLARE_DATAFACTORY(SIM_GeometryCopy,
                        SIM_Geometry,
                        "Geometry Copy",
                        getGeometryCopyDopDescription());
};

#endif

---