ClipPlane.h

Go to the documentation of this file.

/*
Copyright 2007-2025. Algoryx Simulation AB.
 
All AGX source code, intellectual property, documentation, sample code,
tutorials, scene files and technical white papers, are copyrighted, proprietary
and confidential material of Algoryx Simulation AB. You may not download, read,
store, distribute, publish, copy or otherwise disseminate, use or expose this
material unless having a written signed agreement with Algoryx Simulation AB, or having been
advised so by Algoryx Simulation AB for a time limited evaluation, or having purchased a
valid commercial license from Algoryx Simulation AB.
 
Algoryx Simulation AB disclaims all responsibilities for loss or damage caused
from using this software, unless otherwise stated in written agreements with
Algoryx Simulation AB.
*/
 
#pragma once
 
#include <agx/PushDisableWarnings.h> // Disabling warnings. Include agx/PopDisableWarnings.h below!
#include <osg/ClipNode>
#include <agx/PopDisableWarnings.h> // End of disabled warnings.
#include <agx/Plane.h>
 
#include <agxOSG/export.h>
#include <agxOSG/Node.h>
 
// Forward declaration
namespace agx
{
  class ParticleSystem;
}
 
namespace agxOSG
{
  AGX_DECLARE_POINTER_TYPES(ClipPlane);
  AGX_DECLARE_VECTOR_TYPES(ClipPlane);
 
  class AGXOSG_EXPORT ClipPlane : public osg::ClipNode
  {
  public:
    ClipPlane( const agx::Plane& plane );
 
    ClipPlane( const agx::Vec3& normal, const agx::Vec3& position );
 
    ClipPlane( agx::Real a, agx::Real b, agx::Real c, agx::Real d );
 
    void setClipPlane( const agx::Plane& plane );
 
    void setPosition( const agx::Vec3& position );
 
    void setNormal( const agx::Vec3& normal );
 
    void setParticleSystemToClip( agx::ParticleSystem* system );
 
    void setEnable(bool enable);
 
    agx::Plane getPlane() const;
 
    agx::Vec3 getPosition() const;
 
    agx::Vec3 getNormal() const;
 
    bool getEnable() const;
 
    void clipAgainstParticleSystem();
 
  private:
    void setDataFromPlane(const agx::Plane& plane);
 
  private:
    agx::Vec3                    m_position;
    agx::Vec3                    m_normal;
    osg::ref_ptr<osg::ClipPlane> m_clipPlane;
    agx::ParticleSystem*         m_system;
  };
}