Fish - FiberLib for VISH 0.3
Fish - The Fiber Bundle API for the Vish Visualization Shell
Fiber::RegularlyFragmentedGrid< VertexDims > Struct Template Reference
Inheritance diagram for Fiber::RegularlyFragmentedGrid< VertexDims >:
Fiber::RegularlyFragmentedGridBase Fiber::TypedGrid Eagle::StrongPtr< Object, ObjectBase > MemCore::WeakPtr< Object, ObjectBase > MemCore::DynPtr< Object, ObjectBase > Fiber::RegularlyFragmentedGridWithCartesianVertices< 3 > Fiber::RegularlyFragmentedGridWithCartesianVertices< VertexDims > Fiber::FragmentedUniformGrid3D Fiber::FragmentedUniformGrid3DPoints Fiber::RegularlyFragmentedCurvilinearGrid3D Fiber::RegularlyFragmentedClusteredPointCloudGrid

Public Types

typedef MemArray< VertexDims, RefPtr< FragmentID > > FragmentArray_t
Public Types inherited from Eagle::StrongPtr< Object, ObjectBase >
typedef WeakPtr< Object, ObjectBase >::ObjectBase_t ObjectBase_t
Public Types inherited from MemCore::WeakPtr< Object, ObjectBase >
typedef Object object_t
typedef ObjectBase ObjectBase_t
typedef RefPtrTypeTrait< Object, ObjectBase >::ReferencePointerType pointer_t
typedef RefPtrTypeTrait< Object, ObjectBase >::ReferenceValueType refvalue_t
Public Types inherited from MemCore::DynPtr< Object, ObjectBase >
typedef Object object_t

Public Member Functions

MultiIndex< VertexDims > NumberOfFragments () const
 Get the number of fragments here as multi-dimensional index.
RefPtr< FragmentIDgetFragmentID (const MultiIndex< VertexDims > &FragmentIndex) const
 Get the fragment ID for the given fragment index.
 RegularlyFragmentedGrid (const RefPtr< Grid > &G=nullptr)
bool assign (const RefPtr< Grid > &theGrid)
Public Member Functions inherited from Fiber::RegularlyFragmentedGridBase
bool assign (const RefPtr< Grid > &theGrid)
Public Member Functions inherited from Fiber::TypedGrid
bool assign (const RefPtr< Grid > &theGrid)
bool invalidate ()
 Invalidate the stored Grid pointer and return false.
Public Member Functions inherited from Eagle::StrongPtr< Object, ObjectBase >
StrongPtrassignStrong (const DynPtr_t &other)
StrongPtrassignStrong (const ReferenceBase< ObjectBase_t > *Obj)
StrongPtrassignStrong (const std::nullptr_t &)
auto operator() (Arguments...parameters) const -> decltype((*this->getPtrValue())(parameters...))
refvalue_toperator* () const
pointer_t operator-> () const
StrongPtroperator= (const DynPtr_t &other)
StrongPtroperator= (const ReferenceBase< ObjectBase_t > *Obj)
StrongPtroperator= (const std::initializer_list< StrongPtr > &other)
StrongPtroperator= (const std::nullptr_t &)
StrongPtroperator= (const StrongPtr &other)
auto operator[] (const IndexType &I) const -> decltype((*this->getPtrValue())[I])
 StrongPtr (const ReferenceBase< ObjectBase_t > *Obj)
 StrongPtr (const ReferenceBase< ObjectBase_t > *Obj, const NotNullPtr &)
 StrongPtr (const std::nullptr_t &)
 StrongPtr (const StrongPtr< ChildObject, ObjectBase > &Other)
 StrongPtr (const StrongPtr< Object, ObjectBase > &Other)
 StrongPtr (const WeakPtr< ChildObject, ObjectBase_t > &Other)
Public Member Functions inherited from MemCore::WeakPtr< Object, ObjectBase >
 WeakPtr (const std::nullptr_t &)
 WeakPtr (const ReferenceBase< ObjectBase > *Obj)
 WeakPtr (const ReferenceBase< ObjectBase > *Obj, const NotNullPtr &)
 WeakPtr (const WeakPtr< AnyObject, ObjectBase > &Other)
 WeakPtr (const WeakPtr &Other)
pointer_t getPtrValue () const
pointer_t operator-> () const
refvalue_toperator* () const
size_t operator~ () const
WeakPtrassignWeak (const WeakPtr &other)
WeakPtroperator= (const WeakPtr &other)
Public Member Functions inherited from MemCore::DynPtr< Object, ObjectBase >
const DynPtrgetDynPtr () const noexcept
const type_info & getType () const noexcept
bool isAssignable (const DynPtr< ObjectBase, ObjectBase > &Other) const noexcept
 operator void * () const noexcept
bool operator! () const noexcept
void speak (const char *s, const char *prefix="") const noexcept
void Speak (const char *s, const char *prefix="") const

Static Public Member Functions

static SkeletonID FragmentSkeletonID (int IndexDepth=0, int RefLevel=0)
static SkeletonID ID ()
static SkeletonID FragmentSkeletonID (const SkeletonID &S)
static RegularlyFragmentedGrid create (Grid &myGrid, const RefPtr< RegularlyFragmentedField< VertexDims > > &VertexPositions, const SkeletonID &FragmentedSkeletonID)
 Create a fragment skeleton on the given Grid.
static RegularlyFragmentedGrid create (Grid &myGrid, const RefPtr< RegularlyFragmentedField< VertexDims > > &VertexPositions, const RefPtr< Skeleton > &Vertices)
static RegularlyFragmentedGrid create (Grid &myGrid, const RefPtr< RegularlyFragmentedField< VertexDims > > &VertexPositions)
static RegularlyFragmentedGrid createFragmentSkeleton (Grid &myGrid, const RefPtr< Skeleton > &Vertices, const RefPtr< RegularlyFragmentedField< VertexDims > > &VertexPositions, Skeleton &FragmentSkeleton)
static RegularlyFragmentedGrid createWithCartesianVertices (Grid &myGrid, const MultiIndex< VertexDims > &NumberOfFragments)
Static Public Member Functions inherited from Fiber::RegularlyFragmentedGridBase
static SkeletonID FragmentVerticesSkeletonID ()
static SkeletonID computeFragmentSkeletonID (const Field &F, const SkeletonID &SID)
static void create (Grid &myGrid)
Static Public Member Functions inherited from MemCore::DynPtr< Object, ObjectBase >
static const DynPtrgetNullPtr () noexcept

Public Attributes

RefPtr< SkeletonFragmentSkeleton
RefPtr< RepresentationFragmentsAsVertices
 Fields per fragment providing coordinate-independent information.
RefPtr< FragmentArray_t > FragmentArray
Public Attributes inherited from Fiber::RegularlyFragmentedGridBase
RefPtr< SkeletonFragmentVerticesSkeleton
 The Skeleton containing the vertices of fragments, i.e.

Static Public Attributes

static constexpr int Dims = VertexDims

Additional Inherited Members

Protected Member Functions inherited from MemCore::WeakPtr< Object, ObjectBase >
 WeakPtr (Object *that, const SelfInitialize &)
Protected Member Functions inherited from MemCore::DynPtr< Object, ObjectBase >
 DynPtr (const DynPtr< AnyObject, ObjectBase > &Other) noexcept
 DynPtr (const std::nullptr_t &) noexcept

Member Function Documentation

◆ create()

template<int VertexDims>
RegularlyFragmentedGrid Fiber::RegularlyFragmentedGrid< VertexDims >::create ( Grid & myGrid,
const RefPtr< RegularlyFragmentedField< VertexDims > > & VertexPositions,
const SkeletonID & FragmentedSkeletonID )
inlinestatic

Create a fragment skeleton on the given Grid.

Vertices must exist already in the Grid for this function to succeed, but the properties of the vertices itself may be undefined yet. The dimensionality of the given VertexPositions field will be used.

References Fiber::SkeletonMap::findVertices().

Referenced by Fiber::RegularlyFragmentedGridWithCartesianVertices< VertexDims >::create().

◆ getFragmentID()

template<int VertexDims>
RefPtr< FragmentID > Fiber::RegularlyFragmentedGrid< VertexDims >::getFragmentID ( const MultiIndex< VertexDims > & FragmentIndex) const
inline

Get the fragment ID for the given fragment index.

Requires valid fragment array.

◆ NumberOfFragments()

template<int VertexDims>
MultiIndex< VertexDims > Fiber::RegularlyFragmentedGrid< VertexDims >::NumberOfFragments ( ) const
inline

Get the number of fragments here as multi-dimensional index.

Requires valid fragment array.