PeriDyno 1.0.0
Loading...
Searching...
No Matches
dyno::Frame< TDataType > Class Template Reference

A frame represents a point equipped with the orientation. More...

#include <Frame.h>

Inheritance diagram for dyno::Frame< TDataType >:
Collaboration diagram for dyno::Frame< TDataType >:

Public Types

typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
typedef TDataType::Matrix Matrix
 
- Public Types inherited from dyno::TopologyModule
typedef PointType Point
 
typedef VectorND< PointType, 2 > Edge
 
typedef Vector< PointType, 3 > Triangle
 
typedef VectorND< PointType, 4 > Quad
 
typedef VectorND< PointType, 4 > Tetrahedron
 
typedef VectorND< PointType, 5 > Pyramid
 
typedef VectorND< PointType, 6 > Pentahedron
 
typedef VectorND< PointType, 8 > Hexahedron
 
typedef VectorND< PointType, 2 > Edg2Tri
 
typedef VectorND< PointType, 3 > Tri2Edg
 
typedef VectorND< PointType, 2 > Edg2Quad
 
typedef VectorND< PointType, 4 > Quad2Edg
 
typedef VectorND< PointType, 2 > Tri2Tet
 
typedef VectorND< PointType, 4 > Tet2Tri
 
typedef VectorND< PointType, 2 > Tri2Quad
 
typedef VectorND< PointType, 2 > Quad2Hex
 
typedef VectorND< PointType, 2 > Edg2Hex
 
typedef VectorND< PointType, 2 > Edg2Poly
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 

Public Member Functions

 Frame ()
 
 ~Frame () override
 
void copyFrom (Frame< TDataType > &frame)
 
void setCenter (Coord c)
 
Coord getCenter ()
 
void setOrientation (Matrix mat)
 
Matrix getOrientation ()
 
- Public Member Functions inherited from dyno::TopologyModule
 TopologyModule ()
 
 ~TopologyModule () override
 
virtual int getDOF ()
 
void tagAsChanged ()
 
void tagAsUnchanged ()
 
bool isTopologyChanged ()
 
void update ()
 
- Public Member Functions inherited from dyno::OBase
 OBase ()
 
 ~OBase () override
 
virtual std::string caption ()
 Return the caption.
 
virtual bool captionVisible ()
 Whether to hide the caption in the GUI.
 
virtual std::string description ()
 Return a description for the node or module, override this function to support user-defined description.
 
virtual std::string getName ()
 
bool addField (FBase *data)
 Add a field to Base FieldID will be set to the name of Field by default.
 
bool addField (FieldID name, FBase *data)
 Add a field to Base.
 
bool addFieldAlias (FieldID name, FBase *data)
 
bool addFieldAlias (FieldID name, FBase *data, FieldMap &fieldAlias)
 
bool findField (FBase *data)
 Find a field by its pointer.
 
bool findFieldAlias (const FieldID name)
 Find a field by its name.
 
bool findFieldAlias (const FieldID name, FieldMap &fieldAlias)
 Find a field in fieldAlias by its name This function is typically called by other functions.
 
bool removeField (FBase *data)
 Remove a field by its pointer.
 
bool removeFieldAlias (const FieldID name)
 Remove a field by its name.
 
bool removeFieldAlias (const FieldID name, FieldMap &fieldAlias)
 
FBasegetField (const FieldID name)
 Return a field by its name.
 
std::vector< FBase * > & getAllFields ()
 
virtual bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true)
 Attach a field to Base.
 
template<typename T>
TgetField (FieldID name)
 
bool isAllFieldsReady ()
 Check the completeness of all required fields.
 
std::vector< FieldIDgetFieldAlias (FBase *data)
 
int getFieldAliasCount (FBase *data)
 
void setBlockCoord (float x, float y)
 
float bx ()
 
float by ()
 
bool findInputField (FBase *field)
 
bool addInputField (FBase *field)
 
bool removeInputField (FBase *field)
 
std::vector< FBase * > & getInputFields ()
 
bool findOutputField (FBase *field)
 
bool addOutputField (FBase *field)
 
bool addToOutput (FBase *field)
 
bool removeOutputField (FBase *field)
 
bool removeFromOutput (FBase *field)
 
std::vector< FBase * > & getOutputFields ()
 
bool findParameter (FBase *field)
 
bool addParameter (FBase *field)
 
bool removeParameter (FBase *field)
 
std::vector< FBase * > & getParameters ()
 
- Public Member Functions inherited from dyno::Object
 Object ()
 
virtual ~Object ()
 
ObjectId objectId ()
 

Protected Attributes

Coord m_coord
 
Matrix m_rotation
 
- Protected Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Additional Inherited Members

- Static Public Member Functions inherited from dyno::Object
static bool registerClass (ClassInfo *ci)
 
static ObjectcreateObject (std::string name)
 
static std::map< std::string, ClassInfo * > * getClassMap ()
 
static ObjectId baseId ()
 Base Id.
 
- Protected Member Functions inherited from dyno::TopologyModule
virtual void updateTopology ()
 

Detailed Description

template<typename TDataType>
class dyno::Frame< TDataType >

A frame represents a point equipped with the orientation.

Definition at line 13 of file Frame.h.

Member Typedef Documentation

◆ Coord

template<typename TDataType>
typedef TDataType::Coord dyno::Frame< TDataType >::Coord

Definition at line 17 of file Frame.h.

◆ Matrix

template<typename TDataType>
typedef TDataType::Matrix dyno::Frame< TDataType >::Matrix

Definition at line 18 of file Frame.h.

◆ Real

template<typename TDataType>
typedef TDataType::Real dyno::Frame< TDataType >::Real

Definition at line 16 of file Frame.h.

Constructor & Destructor Documentation

◆ Frame()

template<typename TDataType>
dyno::Frame< TDataType >::Frame ( )

Definition at line 8 of file Frame.cpp.

Here is the caller graph for this function:

◆ ~Frame()

template<typename TDataType>
dyno::Frame< TDataType >::~Frame ( )
inlineoverride

Definition at line 21 of file Frame.h.

Member Function Documentation

◆ copyFrom()

template<typename TDataType>
void dyno::Frame< TDataType >::copyFrom ( Frame< TDataType > & frame)

Definition at line 22 of file Frame.cpp.

Here is the call graph for this function:

◆ getCenter()

template<typename TDataType>
Coord dyno::Frame< TDataType >::getCenter ( )
inline

Definition at line 27 of file Frame.h.

◆ getOrientation()

template<typename TDataType>
Matrix dyno::Frame< TDataType >::getOrientation ( )
inline

Definition at line 30 of file Frame.h.

◆ setCenter()

template<typename TDataType>
void dyno::Frame< TDataType >::setCenter ( Coord c)

Definition at line 15 of file Frame.cpp.

◆ setOrientation()

template<typename TDataType>
void dyno::Frame< TDataType >::setOrientation ( Matrix mat)
inline

Definition at line 29 of file Frame.h.

Member Data Documentation

◆ m_coord

template<typename TDataType>
Coord dyno::Frame< TDataType >::m_coord
protected

Definition at line 33 of file Frame.h.

◆ m_rotation

template<typename TDataType>
Matrix dyno::Frame< TDataType >::m_rotation
protected

Definition at line 34 of file Frame.h.


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