FastUIDraw
Public Member Functions | Friends | List of all members
fastuidraw::PartitionedTessellatedPath::Subset Class Reference

A Subset represents a handle to a portion of a PartitionedTessellatedPath. The handle is invalid once the PartitionedTessellatedPath from which it comes goes out of scope. Do not save these handle values without also saving a handle of the PartitionedTessellatedPath from which they come. More...

#include <partitioned_tessellated_path.hpp>

Public Member Functions

 Subset (void)
 
const Rectbounding_box (void) const
 
c_array< const capcaps (void) const
 
vecN< Subset, 2 > children (void) const
 
bool has_children (void) const
 
unsigned int ID (void) const
 
c_array< const joinjoins (void) const
 
 operator unspecified_bool_type () const
 
c_array< const segment_chainsegment_chains (void) const
 

Friends

class PartitionedTessellatedPath
 

Detailed Description

A Subset represents a handle to a portion of a PartitionedTessellatedPath. The handle is invalid once the PartitionedTessellatedPath from which it comes goes out of scope. Do not save these handle values without also saving a handle of the PartitionedTessellatedPath from which they come.

Definition at line 83 of file partitioned_tessellated_path.hpp.

Constructor & Destructor Documentation

◆ Subset()

fastuidraw::PartitionedTessellatedPath::Subset::Subset ( void  )
inline

Ctor to initialize value to "null" handle.

Definition at line 92 of file partitioned_tessellated_path.hpp.

Member Function Documentation

◆ bounding_box()

const Rect& fastuidraw::PartitionedTessellatedPath::Subset::bounding_box ( void  ) const

Returns the bounding box.

◆ caps()

c_array<const cap> fastuidraw::PartitionedTessellatedPath::Subset::caps ( void  ) const

Returns the caps within this Subset

◆ children()

vecN<Subset, 2> fastuidraw::PartitionedTessellatedPath::Subset::children ( void  ) const

Returns the children of this Subset. It is an error to call this if has_children() returns false.

◆ has_children()

bool fastuidraw::PartitionedTessellatedPath::Subset::has_children ( void  ) const

Returns true if this Subset has child Subset

◆ ID()

unsigned int fastuidraw::PartitionedTessellatedPath::Subset::ID ( void  ) const

Returns the ID of this Subset, i.e. the value to feed to PartitionedTessellatedPath::subset() to get this Subset.

◆ joins()

c_array<const join> fastuidraw::PartitionedTessellatedPath::Subset::joins ( void  ) const

Returns the joins within this Subset

◆ operator unspecified_bool_type()

fastuidraw::PartitionedTessellatedPath::Subset::operator unspecified_bool_type ( ) const
inline

Allows one to legally write to test if Subset is a null-handle:

if (p)
{
// p does refers to data
}
if (!p)
{
// p does not referr to any data
}

Definition at line 113 of file partitioned_tessellated_path.hpp.

◆ segment_chains()

c_array<const segment_chain> fastuidraw::PartitionedTessellatedPath::Subset::segment_chains ( void  ) const

Returns the segments that are within this Subset


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