ForceFieldActor.h

Go to the documentation of this file.

//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of NVIDIA CORPORATION nor the names of its
//    contributors may be used to endorse or promote products derived
//    from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
// PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
// OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Copyright (c) 2018 NVIDIA Corporation. All rights reserved.



#ifndef FORCE_FIELD_ACTOR_H
#define FORCE_FIELD_ACTOR_H

#include "Apex.h"


namespace nvidia
{
namespace apex
{


PX_PUSH_PACK_DEFAULT

class ForceFieldAsset;
class ForceFieldAssetParams;

class ForceFieldActor : public Actor
{
protected:
    virtual ~ForceFieldActor() {}

public:
    virtual bool                    isEnable() = 0;

    virtual bool                    disable() = 0;

    virtual bool                    enable() = 0;

    virtual PxMat44                 getPose() const = 0;

    virtual void                    setPose(const PxMat44& pose) = 0;

    PX_DEPRECATED virtual float     getScale() const = 0;

    PX_DEPRECATED virtual void      setScale(float scale) = 0;

    PX_DEPRECATED virtual float     getCurrentScale() const = 0;

    PX_DEPRECATED virtual void      setCurrentScale(float scale) = 0;



    virtual const char*             getName() const = 0;

    virtual void                    setName(const char* name) = 0;

    virtual void                    setStrength(const float strength) = 0;

    virtual void                    setLifetime(const float lifetime) = 0;

    PX_DEPRECATED virtual void      setFalloffType(const char* type) = 0;

    PX_DEPRECATED virtual void      setFalloffMultiplier(const float multiplier) = 0;

    virtual ForceFieldAsset*        getForceFieldAsset() const = 0;

};

PX_POP_PACK

} // namespace apex
} // namespace nvidia

#endif // FORCE_FIELD_ACTOR_H