gls_dynamic_path.h

Go to the documentation of this file.

/*! \file
  \brief  The disti::GlsDynamicPath class and global enumerations.

  \par Copyright Information

  Copyright (c) 2017 by The DiSTI Corporation.<br>
  11301 Corporate Blvd., Suite 100<br>
  Orlando, Florida 32817<br>
  USA<br>
  <br>
  All rights reserved.<br>

  This Software contains proprietary trade secrets of DiSTI and may not be
reproduced, in whole or part, in any form, or by any means of electronic,
mechanical, or otherwise, without the written permission of DiSTI.  Said
permission may be derived through the purchase of applicable DiSTI product
licenses which detail the distribution rights of this content and any
Derivative Works based on this or other copyrighted DiSTI Software.

  NO WARRANTY. THE SOFTWARE IS PROVIDED "AS-IS," WITHOUT WARRANTY OF ANY KIND,
AND ANY USE OF THIS SOFTWARE PRODUCT IS AT YOUR OWN RISK. TO THE MAXIMUM EXTENT
PERMITTED BY APPLICABLE LAW, DISTI AND ITS SUPPLIERS DISCLAIM ALL WARRANTIES
AND CONDITIONS, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
IMPLIED WARRANTIES AND CONDITIONS OF MERCHANTABILITY AND/OR FITNESS FOR A
PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT, WITH REGARD TO THE SOFTWARE.

  LIMITATION OF LIABILITY. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW,
IN NO EVENT SHALL DISTI OR ITS SUPPLIERS BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
INDIRECT, OR CONSEQUENTIAL DAMAGES WHATSOEVER (INCLUDING, WITHOUT LIMITATION,
DAMAGES FOR LOSS OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF BUSINESS
INFORMATION, OR ANY OTHER PECUNIARY LOSS) ARISING OUT OF THE USE OF OR
INABILITY TO USE THE SOFTWARE, EVEN IF DISTI HAS BEEN ADVISED OF THE POSSIBILITY
OF SUCH DAMAGES.  DISTI'S ENTIRE LIABILITY AND YOUR EXCLUSIVE REMEDY SHALL NOT
EXCEED FIVE DOLLARS (US$5.00).

  The aforementioned terms and restrictions are governed by the laws of the
State of Florida and the United States of America.

*/
#ifndef _GLSDYNAMICPATH_H
#define _GLSDYNAMICPATH_H

#include "gls_cpp_lang_support.h"
#include "group.h"

//////////////////// Provides support for creating DLLs ////////////////////////
#if( defined( GLSGEN_EXPORT_GLSDYNAMICPATH ) || defined( GLSGEN_IMPORT_GLSDYNAMICPATH ) || defined( GLS_EXPORT_GENERATED ) || defined( GLS_IMPORT_GENERATED ) ) \
    && defined( _MSC_VER )
#    if defined( GLSGEN_EXPORT_GLSDYNAMICPATH ) || defined( GLS_EXPORT_GENERATED )
#        define GLSGEN_GLSDYNAMICPATH_EXPORT __declspec( dllexport )
#    else
#        define GLSGEN_GLSDYNAMICPATH_EXPORT __declspec( dllimport )
#    endif
#else
#    define GLSGEN_GLSDYNAMICPATH_EXPORT
#endif
///////////////////////////////////////////////////////////////////////////////

#define LIB_BASE_NAME "gls_dynamic_path"
#include "gls_auto_lib.h"
#undef LIB_BASE_NAME

namespace disti
{
// SetValue enumerations
enum
{
    GLS_DYNAMICPATH_FIRST_VALUE = GLS_LAST_INITIALIZER + 1,
    GLS_DYNAMICPATH_AFFECTS_LOCATION_X,
    GLS_DYNAMICPATH_AFFECTS_LOCATION_Y,
    GLS_DYNAMICPATH_AFFECTS_LOCATION_Z,
    GLS_DYNAMICPATH_AFFECTS_ROTATION_X,
    GLS_DYNAMICPATH_AFFECTS_ROTATION_Y,
    GLS_DYNAMICPATH_AFFECTS_ROTATION_Z,
    GLS_DYNAMICPATH_AFFECTS_SCALE_X,
    GLS_DYNAMICPATH_AFFECTS_SCALE_Y,
    GLS_DYNAMICPATH_AFFECTS_SCALE_Z,
    GLS_DYNAMICPATH_USE_SHORT_ROTATION_PATHS,
    GLS_DYNAMICPATH_STATE_COUNT,
    GLS_DYNAMICPATH_STATE
};

/** Runtime implementation of a GlsDynamicPath */
class GlsDynamicPath : public DisplayObject
{
    friend class GlsDynamicPathEditor;

private:
    GlsDynamicPath& operator=( const GlsDynamicPath& ) DISTI_SPECIAL_MEM_FUN_DELETE;
    GlsDynamicPath( const GlsDynamicPath& ) DISTI_SPECIAL_MEM_FUN_DELETE;

public:
    DISTI_DEPRECATED( "This identifier is forbidden by the C++ standard. Use BaseClass instead." )
    typedef DisplayObject _BaseClass;
    typedef DisplayObject BaseClass;

    /** Create a new GlsDynamicPath.
      * \param generateInstanceName  Whether or not to generate an instance name
      * for this inputdevice */
    GLSGEN_GLSDYNAMICPATH_EXPORT GlsDynamicPath( bool generateInstanceName = false );

    /** The copy constructor for GlsDynamicPath
      * 
      * \param that          The GlsDynamicPath object that is being copied
      * \param generateNames Whether or not to generate a new instance name
      */
    GLSGEN_GLSDYNAMICPATH_EXPORT GlsDynamicPath( const GlsDynamicPath& that, const bool generateNames );

    /** Destructs a GlsDynamicPath object */
    virtual GLSGEN_GLSDYNAMICPATH_EXPORT ~GlsDynamicPath();

    static GLSGEN_GLSDYNAMICPATH_EXPORT DisplayObject* CreateInstance();

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void SetAvailableAttributes( unsigned int value ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT DisplayObject* CloneObject( bool generateNames = false ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void CopyProperties( DisplayObject* src ) DISTI_METHOD_OVERRIDE;

#ifndef GLES
    virtual GLSGEN_GLSDYNAMICPATH_EXPORT InterfaceListType* GetCppInterfaceDescription( InterfaceListType* addToThisList = NULL ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void               GetCppInterfaceDescriptionFree( InterfaceListType* array ) DISTI_METHOD_OVERRIDE;
#endif

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void PreDraw( const OpenGLMatrices& parentMatrices, Culler& culler ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void Draw( void ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT DisplayObject* handle( DisplayEvent* ev ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT bool Hit( float x, float y, float z, float scale, const Vector& directionVector, Vector* collisionPoint ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void SetValue( int spec, va_list& args ) DISTI_METHOD_OVERRIDE;

    virtual GLSGEN_GLSDYNAMICPATH_EXPORT DistiAttributeBase& Resource( const char* name ) DISTI_METHOD_OVERRIDE;
    virtual GLSGEN_GLSDYNAMICPATH_EXPORT void                GetResources( std::ostream& outstr, GlsResourceFilter* filter ) DISTI_METHOD_OVERRIDE;

    //////////////////////////////////////////////////
    // GlsDynamicPath specific operations
    //////////////////////////////////////////////////

    // Controls whether the path will affect the X component of the object's dynamic translation.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsLocationX( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsLocationX() const { return _affectsLocationX; }

    // Controls whether the path will affect the Y component of the object's dynamic translation.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsLocationY( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsLocationY() const { return _affectsLocationY; }

    // Controls whether the path will affect the Z component of the object's dynamic translation.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsLocationZ( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsLocationZ() const { return _affectsLocationZ; }

    // Controls whether the path will affect the X component of the object's dynamic rotation.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsRotationX( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsRotationX() const { return _affectsRotationX; }

    // Controls whether the path will affect the Y component of the object's dynamic rotation.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsRotationY( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsRotationY() const { return _affectsRotationY; }

    // Controls whether the path will affect the Z component of the object's dynamic rotation.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsRotationZ( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsRotationZ() const { return _affectsRotationZ; }

    // Controls whether the path will affect the X component of the object's dynamic scale.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsScaleX( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsScaleX() const { return _affectsScaleX; }

    // Controls whether the path will affect the Y component of the object's dynamic scale.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsScaleY( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsScaleY() const { return _affectsScaleY; }

    // Controls whether the path will affect the Z component of the object's dynamic scale.
    GLSGEN_GLSDYNAMICPATH_EXPORT void AffectsScaleZ( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool AffectsScaleZ() const { return _affectsScaleZ; }

    // If true, the shortest path between rotations is taken (360 degrees = no net rotation). If false, the long path is taken.
    GLSGEN_GLSDYNAMICPATH_EXPORT void UseShortRotationPaths( const bool& value );
    GLSGEN_GLSDYNAMICPATH_EXPORT bool UseShortRotationPaths() const { return _useShortRotationPaths; }

    // Contains the data for a state along the path
    class State
    {
        friend class GlsDynamicPath;

    public:
        GLSGEN_GLSDYNAMICPATH_EXPORT State();
        GLSGEN_GLSDYNAMICPATH_EXPORT State( const State& );
        GLSGEN_GLSDYNAMICPATH_EXPORT ~State();

        GLSGEN_GLSDYNAMICPATH_EXPORT const State& operator=( const State& );
        GLSGEN_GLSDYNAMICPATH_EXPORT void         MakeAttribDict();

        DistiAttribDict& Attributes()
        {
            if( !_attribDict )
                MakeAttribDict();
            return *_attribDict;
        };

        void   Location( const Vector& value ) { _location = value; }
        Vector Location() { return _location; }
        Vector Location() const { return _location; }
        void   Rotation( const Vector& value ) { _rotation = value; }
        Vector Rotation() { return _rotation; }
        Vector Rotation() const { return _rotation; }
        void   Scale( const Vector& value ) { _scale = value; }
        Vector Scale() { return _scale; }
        Vector Scale() const { return _scale; }
        void   Value( const float& value ) { _value = value; }
        float  Value() { return _value; }
        float  Value() const { return _value; }

    protected:
        Vector           _location;
        Vector           _rotation;
        Vector           _scale;
        float            _value;
        DistiAttribDict* _attribDict;
    };

    typedef DynamicArray<State> StateArrayType;

    // Returns the StateArray associated with this object.  Use this array to modify the states that make up the path.
    StateArrayType&       StateArray() { return _stateArray; }
    const StateArrayType& StateArray() const { return _stateArray; }

    // Iterates through the path segments and returns the first one found
    // that contains the given value.
    // \param value The value to search for
    // \param index1 returns the index of the state at the start of the segment or -1 if no segments are found
    // \param index2 returns the index of the state at the end the segment or -1 if no segments are found
    // Special cases:
    //     value is before start of the path: index1 == index2 == 0
    //     value is past the end of the path: index1 == index2 == (StateArray().Count()-1)
    GLSGEN_GLSDYNAMICPATH_EXPORT void FindFirstPathSegmentContainingValue( float value, int* index1, int* index2 );

    // \returns the Value for the first state or 0 if there are no states
    float FirstStateValue()
    {
        if( _stateArray.Count() )
        {
            return _stateArray[ 0 ].Value();
        }
        else
        {
            return 0;
        }
    }

    // \returns the Value for the last state or 0 if there are no states
    float LastStateValue()
    {
        if( _stateArray.Count() )
        {
            return _stateArray[ _stateArray.Count() - 1 ].Value();
        }
        else
        {
            return 0;
        }
    }

    /** Get the linearly interpolated location along the path for the given value.
     * \param value The value used to get the path location
     */
    GLSGEN_GLSDYNAMICPATH_EXPORT Vector GetPathLocation( float value );

    /** Get the linearly interpolated rotation along the path for the given value.
     * \param value The value used to get the path rotation
     */
    GLSGEN_GLSDYNAMICPATH_EXPORT Vector GetPathRotation( float value );

    /** Get the linearly interpolated scale along the path for the given value.
     * \param value The value used to get the path scale
     */
    GLSGEN_GLSDYNAMICPATH_EXPORT Vector GetPathScale( float value );

    /** Moves a DisplayObject to the position along the path corresponding with the given value.
     * \param obj the DisplayObject to move
     * \param value The value used to position the object on the path
     */
    GLSGEN_GLSDYNAMICPATH_EXPORT void MoveObject( DisplayObject* obj, float value );

    /** Sets the object to the position corresponding with the given state. 
     * Which values are applied is controlled by the AffectsLocation* and AffectsRotation* properties.
     * \param obj Pointer to the object to move.
     * \param stateNumber The index of the state to set the object to.  If this value is outside the range [0,StateArray().Count()-1] nothing is done.
     */
    GLSGEN_GLSDYNAMICPATH_EXPORT void MoveObjectToState( DisplayObject* obj, int stateNumber );

protected:
#ifdef GLES
    /** Set a single attribute from the GLO file.
     * \param data The attribute to set and its associated data.
     */
    virtual GLS_EXPORT void SetFromGloData( GlsGloFileAttribute& data ) DISTI_METHOD_OVERRIDE;
#endif

    bool _affectsLocationX;
    bool _affectsLocationY;
    bool _affectsLocationZ;
    bool _affectsRotationX;
    bool _affectsRotationY;
    bool _affectsRotationZ;
    bool _affectsScaleX;
    bool _affectsScaleY;
    bool _affectsScaleZ;

    bool _useShortRotationPaths;

    StateArrayType _stateArray;
};

} // namespace disti

#endif