mmcfilters
Public API documentation
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
mmcfilters::NodeAttributeSampleKey Struct Reference

Composite key used to index sampled node-attribute layouts. More...

#include <AttributeTypes.hpp>

Collaboration diagram for mmcfilters::NodeAttributeSampleKey:
Collaboration graph
[legend]

Public Member Functions

 NodeAttributeSampleKey (Attribute value, int offset=0)
 Builds a composite key for value at offset.
 
bool operator== (const NodeAttributeSampleKey &other) const
 Returns true when both the attribute and sample offset match.
 

Public Attributes

Attribute attribute
 Attribute component of the composite lookup key.
 
int sampleOffset = 0
 Signed ancestor/current/representative-descendant sample coordinate.
 

Detailed Description

Composite key used to index sampled node-attribute layouts.

Definition at line 199 of file AttributeTypes.hpp.

Constructor & Destructor Documentation

◆ NodeAttributeSampleKey()

mmcfilters::NodeAttributeSampleKey::NodeAttributeSampleKey ( Attribute  value,
int  offset = 0 
)
inline

Builds a composite key for value at offset.

A zero offset denotes the current node. Negative offsets refer to ancestor samples and positive offsets refer to representative-descendant samples.

Parameters
valueAttribute component of the composite key.
offsetSample coordinate of the composite key.

Definition at line 216 of file AttributeTypes.hpp.

Member Function Documentation

◆ operator==()

bool mmcfilters::NodeAttributeSampleKey::operator== ( const NodeAttributeSampleKey other) const
inline

Returns true when both the attribute and sample offset match.

Parameters
otherObject to compare with or transfer from.
Returns
True when both key components match.

Definition at line 224 of file AttributeTypes.hpp.

Member Data Documentation

◆ attribute

Attribute mmcfilters::NodeAttributeSampleKey::attribute

Attribute component of the composite lookup key.

Definition at line 201 of file AttributeTypes.hpp.

◆ sampleOffset

int mmcfilters::NodeAttributeSampleKey::sampleOffset = 0

Signed ancestor/current/representative-descendant sample coordinate.

Definition at line 204 of file AttributeTypes.hpp.


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