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

#include <NeighborPointQuery.h>

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

Public Types

typedef TDataType::Real Real
 
typedef TDataType::Coord Coord
 
typedef ::dyno::TAlignedBox3D< RealAABB
 
- Public Types inherited from dyno::OBase
typedef std::vector< FBase * > FieldVector
 
typedef std::map< FieldID, FBase * > FieldMap
 

Public Member Functions

 NeighborPointQuery ()
 
 ~NeighborPointQuery () override
 
void compute () override
 
 DEF_VAR_IN (float, Radius, "Search radius")
 Search radius A positive value representing the radius of neighborhood for each point.
 
 DEF_ARRAY_IN (Vec3f, Position, DeviceType::GPU, "A set of points to be required from")
 A set of points to be required from.
 
 DEF_ARRAY_IN (Vec3f, Other, DeviceType::GPU, "Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.")
 Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.
 
 DEF_ARRAYLIST_OUT (uint32_t, NeighborIds, DeviceType::GPU, "Return neighbor ids")
 Ids of neighboring particles.
 
 NeighborPointQuery ()
 
 ~NeighborPointQuery () override
 
 DECLARE_ENUM (Spatial, UNIFORM=0, BVH=1, OCTREE=2)
 
 DEF_ENUM (Spatial, Spatial, Spatial::UNIFORM, "")
 
 DEF_VAR (uint, SizeLimit, 0, "Maximum number of neighbors")
 
 DEF_VAR_IN (Real, Radius, "Search radius")
 Search radius A positive value representing the radius of neighborhood for each point.
 
 DEF_ARRAY_IN (Coord, Position, DeviceType::GPU, "A set of points whose neighbors will be required for")
 A set of points whose neighbors will be required for.
 
 DEF_ARRAY_IN (Coord, Other, DeviceType::GPU, "Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.")
 Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.
 
 DEF_ARRAYLIST_OUT (int, NeighborIds, DeviceType::GPU, "Return neighbor ids")
 Ids of neighboring particles.
 
 NeighborPointQuery ()
 
 ~NeighborPointQuery () override
 
 DEF_VAR_IN (float, Radius, "Search radius")
 Search radius A positive value representing the radius of neighborhood for each point.
 
 DEF_ARRAY_IN (Vec3f, Position, DeviceType::GPU, "A set of points to be required from")
 A set of points to be required from.
 
 DEF_ARRAY_IN (Vec3f, Other, DeviceType::GPU, "Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.")
 Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.
 
 DEF_ARRAYLIST_OUT (uint32_t, NeighborIds, DeviceType::GPU, "Return neighbor ids")
 Ids of neighboring particles.
 
- Public Member Functions inherited from dyno::ComputeModule
 ComputeModule ()
 
 ~ComputeModule () override
 
std::string getModuleType () override
 
- Public Member Functions inherited from dyno::Module
 Module (std::string name="default")
 
 ~Module (void) override
 
bool initialize ()
 
void update ()
 
void setName (std::string name)
 
std::string getName () override
 
virtual void setParentNode (Node *node)
 Set the parent node.
 
NodegetParentNode ()
 
SceneGraphgetSceneGraph ()
 
bool isInitialized ()
 
bool attachField (FBase *field, std::string name, std::string desc, bool autoDestroy=true) override
 Attach a field to Base.
 
bool isInputComplete ()
 Check the completeness of input fields.
 
bool isOutputCompete ()
 
 DEF_VAR (bool, ForceUpdate, false, "")
 
void setUpdateAlways (bool b)
 Set the update strategy for the module.
 
- 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.
 
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 ()
 
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 Member Functions

void compute () override
 
void compute () override
 
- Protected Member Functions inherited from dyno::Module
virtual bool initializeImpl ()
 
virtual void preprocess ()
 
virtual void postprocess ()
 
virtual bool validateInputs ()
 
virtual bool validateOutputs ()
 
virtual bool requireUpdate ()
 
virtual void updateStarted ()
 Two functions called at the beginning and end of update() used for debug.
 
virtual void updateEnded ()
 

Private Member Functions

void requestDynamicNeighborIds ()
 
void requestFixedSizeNeighborIds ()
 
void requestDynamicNeighborIds ()
 
void requestFixedSizeNeighborIds ()
 
void requestNeighborIdsWithBVH ()
 
void requestNeighborIdsWithOctree ()
 
void requestDynamicNeighborIds ()
 

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 Attributes inherited from dyno::OBase
std::vector< FBase * > fields_input
 
std::vector< FBase * > fields_output
 
std::vector< FBase * > fields_param
 

Detailed Description

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

Definition at line 21 of file NeighborPointQuery.h.

Member Typedef Documentation

◆ AABB

template<typename TDataType>
typedef ::dyno::TAlignedBox3D<Real> dyno::NeighborPointQuery< TDataType >::AABB

Definition at line 30 of file NeighborPointQuery.h.

◆ Coord

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

Definition at line 29 of file NeighborPointQuery.h.

◆ Real

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

Definition at line 28 of file NeighborPointQuery.h.

Constructor & Destructor Documentation

◆ NeighborPointQuery() [1/3]

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

Definition at line 19 of file NeighborPointQuery.cpp.

Here is the call graph for this function:

◆ ~NeighborPointQuery() [1/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::~NeighborPointQuery ( )
override

Definition at line 67 of file NeighborPointQuery.cpp.

◆ NeighborPointQuery() [2/3]

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

◆ ~NeighborPointQuery() [2/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::~NeighborPointQuery ( )
override

◆ NeighborPointQuery() [3/3]

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

◆ ~NeighborPointQuery() [3/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::~NeighborPointQuery ( )
override

Member Function Documentation

◆ compute() [1/3]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::compute ( )
overridevirtual

Implements dyno::ComputeModule.

Definition at line 71 of file NeighborPointQuery.cpp.

Here is the call graph for this function:

◆ compute() [2/3]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::compute ( )
overrideprotectedvirtual

Implements dyno::ComputeModule.

◆ compute() [3/3]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::compute ( )
overrideprotectedvirtual

Implements dyno::ComputeModule.

◆ DECLARE_ENUM()

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DECLARE_ENUM ( Spatial ,
UNIFORM = 0,
BVH = 1,
OCTREE = 2 )

◆ DEF_ARRAY_IN() [1/6]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAY_IN ( Coord ,
Other ,
DeviceType::GPU ,
"Another set of points the algorithm will require neighbor ids for. If not set,
the set of points in Position will be required."  )

Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.

◆ DEF_ARRAY_IN() [2/6]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAY_IN ( Coord ,
Position ,
DeviceType::GPU ,
"A set of points whose neighbors will be required for"  )

A set of points whose neighbors will be required for.

◆ DEF_ARRAY_IN() [3/6]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAY_IN ( Vec3f ,
Other ,
DeviceType::GPU ,
"Another set of points the algorithm will require neighbor ids for. If not set,
the set of points in Position will be required."  )

Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.

◆ DEF_ARRAY_IN() [4/6]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAY_IN ( Vec3f ,
Other ,
DeviceType::GPU ,
"Another set of points the algorithm will require neighbor ids for. If not set,
the set of points in Position will be required."  )

Another set of points the algorithm will require neighbor ids for. If not set, the set of points in Position will be required.

◆ DEF_ARRAY_IN() [5/6]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAY_IN ( Vec3f ,
Position ,
DeviceType::GPU ,
"A set of points to be required from"  )

A set of points to be required from.

◆ DEF_ARRAY_IN() [6/6]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAY_IN ( Vec3f ,
Position ,
DeviceType::GPU ,
"A set of points to be required from"  )

A set of points to be required from.

◆ DEF_ARRAYLIST_OUT() [1/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAYLIST_OUT ( int ,
NeighborIds ,
DeviceType::GPU ,
"Return neighbor ids"  )

Ids of neighboring particles.

◆ DEF_ARRAYLIST_OUT() [2/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAYLIST_OUT ( uint32_t ,
NeighborIds ,
DeviceType::GPU ,
"Return neighbor ids"  )

Ids of neighboring particles.

◆ DEF_ARRAYLIST_OUT() [3/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ARRAYLIST_OUT ( uint32_t ,
NeighborIds ,
DeviceType::GPU ,
"Return neighbor ids"  )

Ids of neighboring particles.

◆ DEF_ENUM()

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_ENUM ( Spatial ,
Spatial ,
Spatial::UNIFORM ,
""  )

◆ DEF_VAR()

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_VAR ( uint ,
SizeLimit ,
0 ,
"Maximum number of neighbors"  )

◆ DEF_VAR_IN() [1/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_VAR_IN ( float ,
Radius ,
"Search radius"  )

Search radius A positive value representing the radius of neighborhood for each point.

◆ DEF_VAR_IN() [2/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_VAR_IN ( float ,
Radius ,
"Search radius"  )

Search radius A positive value representing the radius of neighborhood for each point.

◆ DEF_VAR_IN() [3/3]

template<typename TDataType>
dyno::NeighborPointQuery< TDataType >::DEF_VAR_IN ( Real ,
Radius ,
"Search radius"  )

Search radius A positive value representing the radius of neighborhood for each point.

◆ requestDynamicNeighborIds() [1/3]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestDynamicNeighborIds ( )
private

Definition at line 76 of file NeighborPointQuery.cpp.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ requestDynamicNeighborIds() [2/3]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestDynamicNeighborIds ( )
private

◆ requestDynamicNeighborIds() [3/3]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestDynamicNeighborIds ( )
private

◆ requestFixedSizeNeighborIds() [1/2]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestFixedSizeNeighborIds ( )
private

◆ requestFixedSizeNeighborIds() [2/2]

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestFixedSizeNeighborIds ( )
private

◆ requestNeighborIdsWithBVH()

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestNeighborIdsWithBVH ( )
private

◆ requestNeighborIdsWithOctree()

template<typename TDataType>
void dyno::NeighborPointQuery< TDataType >::requestNeighborIdsWithOctree ( )
private

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