FEMSuite
Public Member Functions | Protected Attributes | List of all members
Boundary Class Referenceabstract

Generic definition of boundary More...

#include <Boundary.h>

Inheritance diagram for Boundary:
Inheritance graph
[legend]
Collaboration diagram for Boundary:
Collaboration graph
[legend]

Public Member Functions

virtual void Move (IScreen *, const PolarVector &) override
 
Radian GetTheta () const
 
void SetTheta (const Radian th)
 
Radian GetPhi () const
 
void SetPhi (const Radian phi)
 
virtual DimensionArray< Spatial > GetDimensions () const
 
virtual void SetDimensions (const DimensionArray< Spatial > &d)
 
virtual void CalculateVertices ()
 
virtual bool IncludesPoint (const Point< Spatial > &)=0
 Determines whether this boundary covers a given point More...
 
virtual bool IncludesPoint (IScreen *, const ScreenCoords &sC) override
 Enables a pixel-level extension of the entire footprint. More...
 
virtual bool IsDeformationPoint (IScreen *, const ScreenCoords &sC)
 Enables a pixel-level extension of the deformation aid footprint. More...
 
virtual bool IsResizingPoint (IScreen *, const ScreenCoords &sC)
 Enables a pixel-level extension of the resizing aid footprint. More...
 
virtual bool IsRotationPoint (IScreen *, const ScreenCoords &sC)
 Enables a pixel-level extension of the rotation aid footprint. More...
 
virtual DimensionArray< PointExtentsCalculateExtents () const =0
 Calculates extents in all directions More...
 
virtual const MediumGetMedium ()
 
virtual void SetMedium (const Medium &)
 
virtual void AddParameters () override
 
virtual void UpdateFromParameters (std::shared_ptr< IParameter >=nullptr) override
 The argument here is the updated paramter More...
 
- Public Member Functions inherited from InteractiveObjectBase
ObjectManagerGetObjectManager () const override
 
void SetObjectManager (ObjectManager *const om) override
 
virtual void MouseUp () override
 
virtual bool IsSelected () const override
 
virtual void SetSelected (const bool s=true) override
 
virtual bool IsHovered () const override
 
virtual void SetHovered (const bool h=true) override
 
virtual bool IsRotatable ()
 Whether the object can be rotated or not More...
 
virtual void SetRotatable (const bool isRotatable=true) override
 
virtual bool IsMovable ()
 Whether the object can be moved or not More...
 
virtual void SetMovable (const bool isMovable=true) override
 
virtual bool IsResizable ()
 Whether the object can be resized or not More...
 
virtual void SetResizable (const bool isResizable=true) override
 
virtual std::string GetName () const override
 
virtual void SetName (const std::string &name) override
 
virtual Point< Spatial > GetCenter () const
 
virtual void SetCenter (const Point< Spatial > &c)
 
virtual Color GetColor () const
 
virtual void SetColor (const Color &c)
 
virtual IScreen::CursorType GetCursor (IScreen *, const ScreenCoords &) override
 
virtual IScreen::CursorType HeadingToResizingCursor (Radian heading) const
 Converts a direction to a resizing cursor. Used with resizing and scaling as well as other deformation functions. More...
 
virtual void Rotate (IScreen *, const PolarVector &) override
 
virtual void Resize (IScreen *, const PolarVector &) override
 
virtual const DisplayStyleGetDisplayStyle () const override
 
Returns
Current display style that should be used

 
virtual void SetStandardDisplayStyle (const DisplayStyle &ds) override
 
virtual void SetHoveredDisplayStyle (const DisplayStyle &ds) override
 
virtual void SetSelectedDisplayStyle (const DisplayStyle &ds) override
 
virtual bool IsVisible (IScreen *)
 
virtual void Draw2D (IScreen *)
 
virtual void Draw3D (IScreen *)
 
virtual void DrawResizingSquare (IScreen *, const Point< Spatial > &, const Radian=0)
 
virtual void DrawRotationCircle (IScreen *, const Point< Spatial > &)
 
virtual IParameterContainer & GetParameters () override
 Returns a list of all parameters More...
 
virtual void AddIParameter (std::shared_ptr< IParameter > p) override
 
virtual void AddIParameterTEST ()
 
virtual void RemoveParameter (const std::string &name) override
 
virtual void ClearParameters () override
 
virtual std::shared_ptr< IParameterGetIParameter (const std::string &name) override
 Finds a parameter by name More...
 
- Public Member Functions inherited from IInteractiveObject
template<class T , typename... Args>
std::shared_ptr< T > Get (Args...args)
 
template<class T , typename... Args>
std::shared_ptr< Parameter< T > > GetParameter (Args...args)
 
template<class T , typename... Args>
std::shared_ptr< Parameter< T > > AddParameter (Args...args)
 
template<class T , typename... Args>
std::shared_ptr< T > Add (Args...args)
 
template<typename... Args>
std::shared_ptr< DegreeParameterAddDegreeParameter (Args...args)
 
template<typename... Args>
std::shared_ptr< DegreeParameterGetDegreeParameter (Args...args)
 
template<typename... Args>
std::shared_ptr< MediumParameterAddMediumParameter (Args...args)
 
template<typename... Args>
std::shared_ptr< MediumParameterGetMediumParameter (Args...args)
 

Protected Attributes

Radian m_Theta
 Specifies the azimuthal angle of this vector More...
 
Radian m_Phi
 Specifies the elevation angle of this vector More...
 
DimensionArray< Spatial > m_Dimensions
 Specifies the dimensions in each direction More...
 
- Protected Attributes inherited from InteractiveObjectBase
ObjectManagerm_ObjectManager
 
Point< Spatial > m_Center
 Center of the shape More...
 
Color m_Color
 Color of the shape More...
 
std::vector< std::shared_ptr< IParameter > > m_Parameters
 

Detailed Description

Generic definition of boundary

Member Function Documentation

virtual DimensionArray<PointExtents> Boundary::CalculateExtents ( ) const
pure virtual

Calculates extents in all directions

Implemented in Parallelepiped.

virtual bool Boundary::IncludesPoint ( const Point< Spatial > &  )
pure virtual

Determines whether this boundary covers a given point

Parameters
pointPoint in question

Implemented in FDTDProblemArea, Parallelepiped, and EllipseBoundary.

bool Boundary::IncludesPoint ( IScreen ,
const ScreenCoords sC 
)
overridevirtual

Enables a pixel-level extension of the entire footprint.

Reimplemented from InteractiveObjectBase.

virtual bool Boundary::IsDeformationPoint ( IScreen ,
const ScreenCoords sC 
)
inlinevirtual

Enables a pixel-level extension of the deformation aid footprint.

Reimplemented from InteractiveObjectBase.

virtual bool Boundary::IsResizingPoint ( IScreen ,
const ScreenCoords sC 
)
inlinevirtual

Enables a pixel-level extension of the resizing aid footprint.

Reimplemented from InteractiveObjectBase.

Reimplemented in Parallelepiped.

virtual bool Boundary::IsRotationPoint ( IScreen ,
const ScreenCoords sC 
)
inlinevirtual

Enables a pixel-level extension of the rotation aid footprint.

Reimplemented from InteractiveObjectBase.

Reimplemented in Parallelepiped, and EllipseBoundary.

void Boundary::UpdateFromParameters ( std::shared_ptr< IParameter p = nullptr)
overridevirtual

The argument here is the updated paramter

Reimplemented from InteractiveObjectBase.

Reimplemented in Parallelepiped.

Member Data Documentation

DimensionArray< Spatial > Boundary::m_Dimensions
protected

Specifies the dimensions in each direction

Radian Boundary::m_Phi
protected

Specifies the elevation angle of this vector

Radian Boundary::m_Theta
protected

Specifies the azimuthal angle of this vector


The documentation for this class was generated from the following files: