HDK
|
Namespaces | |
attribute_traits | |
future | |
A container for ABI=5 to help ease introduction of upcoming features. | |
index | |
index_filter_internal | |
internal | |
point_advect_internal | |
point_attribute_internal | |
point_conversion_internal | |
point_delete_internal | |
point_group_internal | |
point_mask_internal | |
point_move_internal | |
point_sample_internal | |
point_scatter_internal | |
Classes | |
class | AttributeArray |
Base class for storing attribute data. More... | |
struct | UnknownCodec |
struct | NullCodec |
struct | TruncateCodec |
struct | PositionRange |
struct | UnitRange |
struct | FixedPointCodec |
struct | UnitVecCodec |
class | TypedAttributeArray |
Typed class for storing attribute data. More... | |
class | AttributeHandle |
class | AttributeWriteHandle |
Write-able version of AttributeHandle. More... | |
struct | AccessorEval |
Accessor to call unsafe get and set methods based on templated Codec and Value. More... | |
struct | AccessorEval< UnknownCodec, ValueType > |
Partial specialization when Codec is not known at compile-time to use the supplied functor instead. More... | |
struct | StringCodec |
class | StringMetaCache |
Class to compute a string->index map from all string:N metadata. More... | |
class | StringMetaInserter |
Class to help with insertion of keyed string values into metadata. More... | |
class | StringAttributeHandle |
class | StringAttributeWriteHandle |
struct | GroupCodec |
class | GroupHandle |
class | GroupWriteHandle |
class | GroupFilter |
Index filtering on group membership. More... | |
class | AttributeSet |
Ordered collection of uniquely-named attribute arrays. More... | |
class | ValueMaskFilter |
Index filtering on active / inactive state of host voxel. More... | |
class | MultiGroupFilter |
class | RandomLeafFilter |
class | AttributeHashFilter |
class | LevelSetFilter |
class | BBoxFilter |
class | BinaryFilter |
struct | FilterTraits |
struct | FilterTraits< BBoxFilter > |
struct | FilterTraits< LevelSetFilter< T > > |
struct | FilterTraits< BinaryFilter< T0, T1, And > > |
class | NullFilter |
A no-op filter that can be used when iterating over all indices. More... | |
class | ValueVoxelCIter |
A forward iterator over array indices in a single voxel. More... | |
class | IndexIter |
A forward iterator over array indices with filtering IteratorT can be either IndexIter or ValueIndexIter (or some custom index iterator) FilterT should be a struct or class with a valid() method than can be evaluated per index Here's a simple filter example that only accepts even indices: More... | |
class | PointAttributeVector |
Point-partitioner compatible STL vector attribute wrapper for convenience. More... | |
class | PointDataLeafNode |
struct | TreeConverter |
Similiar to ValueConverter, but allows for tree configuration conversion to a PointDataTree. ValueConverter<PointDataIndex32> cannot be used as a PointDataLeafNode is not a specialization of LeafNode. More... | |
struct | NullDeformer |
No-op deformer (adheres to the deformer interface documented in PointMove.h) More... | |
struct | DeformerTraits |
Deformer Traits for optionally configuring deformers to be applied in index-space. The default is world-space. More... | |
class | CachedDeformer |
A Deformer that caches the resulting positions from evaluating another Deformer. More... | |
struct | SampleWithRounding |
struct | DummySampleType |
Typedefs | |
using | OPENVDB_DEPRECATED = Index |
using | StringAttributeArray = TypedAttributeArray< Index, StringCodec< false >> |
using | GroupAttributeArray = TypedAttributeArray< GroupType, GroupCodec > |
using | GroupType = uint8_t |
using | ActiveFilter = ValueMaskFilter< true > |
using | InactiveFilter = ValueMaskFilter< false > |
using | PointDataTree = tree::Tree< tree::RootNode< tree::InternalNode< tree::InternalNode< PointDataLeafNode< PointDataIndex32, 3 >, 4 >, 5 >>> |
Point index tree configured to match the default VDB configurations. More... | |
using | PointDataGrid = Grid< PointDataTree > |
Point data grid. More... | |
Functions | |
template<typename IntegerT , typename FloatT > | |
IntegerT | floatingPointToFixedPoint (const FloatT s) |
template<typename FloatT , typename IntegerT > | |
FloatT | fixedPointToFloatingPoint (const IntegerT s) |
template<typename IntegerVectorT , typename FloatT > | |
IntegerVectorT | floatingPointToFixedPoint (const math::Vec3< FloatT > &v) |
template<typename FloatVectorT , typename IntegerT > | |
FloatVectorT | fixedPointToFloatingPoint (const math::Vec3< IntegerT > &v) |
bool | isString (const AttributeArray &array) |
bool | isGroup (const AttributeArray &array) |
template<typename IterT > | |
Index64 | iterCount (const IterT &iter) |
Count up the number of times the iterator can iterate. More... | |
template<typename PointDataGridT , typename VelGridT , typename AdvectFilterT = NullFilter, typename FilterT = NullFilter> | |
void | advectPoints (PointDataGridT &points, const VelGridT &velocity, const Index integrationOrder, const double dt, const Index timeSteps, const AdvectFilterT &advectFilter=NullFilter(), const FilterT &filter=NullFilter(), const bool cached=true) |
Advect points in a PointDataGrid through a velocity grid. More... | |
template<typename PointDataTreeT > | |
void | appendAttribute (PointDataTreeT &tree, const Name &name, const NamePair &type, const Index strideOrTotalSize=1, const bool constantStride=true, const Metadata *defaultValue=nullptr, const bool hidden=false, const bool transient=false) |
Appends a new attribute to the VDB tree (this method does not require a templated AttributeType) More... | |
template<typename ValueType , typename CodecType = NullCodec, typename PointDataTreeT = PointDataTree> | |
void | appendAttribute (PointDataTreeT &tree, const std::string &name, const ValueType &uniformValue=point_attribute_internal::Default< ValueType >::value(), const Index strideOrTotalSize=1, const bool constantStride=true, const TypedMetadata< ValueType > *defaultValue=nullptr, const bool hidden=false, const bool transient=false) |
Appends a new attribute to the VDB tree. More... | |
template<typename ValueType , typename PointDataTreeT > | |
void | collapseAttribute (PointDataTreeT &tree, const Name &name, const ValueType &uniformValue=point_attribute_internal::Default< ValueType >::value()) |
Collapse the attribute into a uniform value. More... | |
template<typename PointDataTreeT > | |
void | dropAttributes (PointDataTreeT &tree, const std::vector< size_t > &indices) |
Drops attributes from the VDB tree. More... | |
template<typename PointDataTreeT > | |
void | dropAttributes (PointDataTreeT &tree, const std::vector< Name > &names) |
Drops attributes from the VDB tree. More... | |
template<typename PointDataTreeT > | |
void | dropAttribute (PointDataTreeT &tree, const size_t &index) |
Drop one attribute from the VDB tree (convenience method). More... | |
template<typename PointDataTreeT > | |
void | dropAttribute (PointDataTreeT &tree, const Name &name) |
Drop one attribute from the VDB tree (convenience method). More... | |
template<typename PointDataTreeT > | |
void | renameAttributes (PointDataTreeT &tree, const std::vector< Name > &oldNames, const std::vector< Name > &newNames) |
Rename attributes in a VDB tree. More... | |
template<typename PointDataTreeT > | |
void | renameAttribute (PointDataTreeT &tree, const Name &oldName, const Name &newName) |
Rename an attribute in a VDB tree. More... | |
template<typename PointDataTreeT > | |
void | compactAttributes (PointDataTreeT &tree) |
Compact attributes in a VDB tree (if possible). More... | |
template<typename PointDataTreeT > | |
OPENVDB_DEPRECATED void | appendAttribute (PointDataTreeT &tree, const Name &name, const NamePair &type, const Index strideOrTotalSize, const bool constantStride, Metadata::Ptr metaDefaultValue, const bool hidden=false, const bool transient=false) |
template<typename ValueType , typename CodecType = NullCodec, typename PointDataTreeT = PointDataTree> | |
OPENVDB_DEPRECATED void | appendAttribute (PointDataTreeT &tree, const std::string &name, const ValueType &uniformValue, const Index strideOrTotalSize, const bool constantStride, Metadata::Ptr metaDefaultValue, const bool hidden=false, const bool transient=false) |
template<typename CompressionT , typename PointDataGridT , typename PositionArrayT , typename PointIndexGridT > | |
PointDataGridT::Ptr | createPointDataGrid (const PointIndexGridT &pointIndexGrid, const PositionArrayT &positions, const math::Transform &xform, const Metadata *positionDefaultValue=nullptr) |
Localises points with position into a PointDataGrid into two stages: allocation of the leaf attribute data and population of the positions. More... | |
template<typename CompressionT , typename PointDataGridT , typename ValueT > | |
PointDataGridT::Ptr | createPointDataGrid (const std::vector< ValueT > &positions, const math::Transform &xform, const Metadata *positionDefaultValue=nullptr) |
Convenience method to create a PointDataGrid from a std::vector of point positions. More... | |
template<typename PointDataTreeT , typename PointIndexTreeT , typename PointArrayT > | |
void | populateAttribute (PointDataTreeT &tree, const PointIndexTreeT &pointIndexTree, const openvdb::Name &attributeName, const PointArrayT &data, const Index stride=1, const bool insertMetadata=true) |
Stores point attribute data in an existing PointDataGrid attribute. More... | |
template<typename PositionAttribute , typename PointDataGridT , typename FilterT = NullFilter> | |
void | convertPointDataGridPosition (PositionAttribute &positionAttribute, const PointDataGridT &grid, const std::vector< Index64 > &pointOffsets, const Index64 startOffset, const FilterT &filter=NullFilter(), const bool inCoreOnly=false) |
Convert the position attribute from a Point Data Grid. More... | |
template<typename TypedAttribute , typename PointDataTreeT , typename FilterT = NullFilter> | |
void | convertPointDataGridAttribute (TypedAttribute &attribute, const PointDataTreeT &tree, const std::vector< Index64 > &pointOffsets, const Index64 startOffset, const unsigned arrayIndex, const Index stride=1, const FilterT &filter=NullFilter(), const bool inCoreOnly=false) |
Convert the attribute from a PointDataGrid. More... | |
template<typename Group , typename PointDataTreeT , typename FilterT = NullFilter> | |
void | convertPointDataGridGroup (Group &group, const PointDataTreeT &tree, const std::vector< Index64 > &pointOffsets, const Index64 startOffset, const AttributeSet::Descriptor::GroupIndex index, const FilterT &filter=NullFilter(), const bool inCoreOnly=false) |
Convert the group from a PointDataGrid. More... | |
template<typename PositionWrapper , typename InterrupterT = openvdb::util::NullInterrupter> | |
float | computeVoxelSize (const PositionWrapper &positions, const uint32_t pointsPerVoxel, const math::Mat4d transform=math::Mat4d::identity(), const Index decimalPlaces=5, InterrupterT *const interrupter=nullptr) |
template<typename CompressionT , typename PointDataGridT , typename PositionArrayT , typename PointIndexGridT > | |
OPENVDB_DEPRECATED PointDataGridT::Ptr | createPointDataGrid (const PointIndexGridT &pointIndexGrid, const PositionArrayT &positions, const math::Transform &xform, Metadata::Ptr positionDefaultValue) |
template<typename CompressionT , typename PointDataGridT , typename ValueT > | |
OPENVDB_DEPRECATED PointDataGridT::Ptr | createPointDataGrid (const std::vector< ValueT > &positions, const math::Transform &xform, Metadata::Ptr positionDefaultValue) |
template<typename PointDataTreeT , typename FilterT = NullFilter> | |
Index64 | pointCount (const PointDataTreeT &tree, const FilterT &filter=NullFilter(), const bool inCoreOnly=false, const bool threaded=true) |
Count the total number of points in a PointDataTree. More... | |
template<typename PointDataTreeT , typename FilterT = NullFilter> | |
Index64 | pointOffsets (std::vector< Index64 > &pointOffsets, const PointDataTreeT &tree, const FilterT &filter=NullFilter(), const bool inCoreOnly=false, const bool threaded=true) |
Populate an array of cumulative point offsets per leaf node. More... | |
template<typename PointDataGridT , typename GridT = typename PointDataGridT::template ValueConverter<Int32>::Type, typename FilterT = NullFilter> | |
GridT::Ptr | pointCountGrid (const PointDataGridT &grid, const FilterT &filter=NullFilter()) |
Generate a new grid with voxel values to store the number of points per voxel. More... | |
template<typename PointDataGridT , typename GridT = typename PointDataGridT::template ValueConverter<Int32>::Type, typename FilterT = NullFilter> | |
GridT::Ptr | pointCountGrid (const PointDataGridT &grid, const openvdb::math::Transform &transform, const FilterT &filter=NullFilter()) |
Generate a new grid that uses the supplied transform with voxel values to store the number of points per voxel. More... | |
template<typename PointDataTreeT > | |
AttributeSet::Descriptor::Ptr | makeDescriptorUnique (PointDataTreeT &tree) |
Deep copy the descriptor across all leaf nodes. More... | |
template<typename PointDataTreeT > | |
void | setStreamingMode (PointDataTreeT &tree, bool on=true) |
Toggle the streaming mode on all attributes in the tree to collapse the attributes after deconstructing a bound AttributeHandle to each array. This results in better memory efficiency when the data is streamed into another data structure (typically for rendering). More... | |
template<typename PointDataTreeT > | |
void | prefetch (PointDataTreeT &tree, bool position=true, bool otherAttributes=true) |
Sequentially pre-fetch all delayed-load voxel and attribute data from disk in order to accelerate subsequent random access. More... | |
template<typename PointDataTreeT > | |
void | deleteFromGroups (PointDataTreeT &pointTree, const std::vector< std::string > &groups, bool invert=false, bool drop=true) |
Delete points that are members of specific groups. More... | |
template<typename PointDataTreeT > | |
void | deleteFromGroup (PointDataTreeT &pointTree, const std::string &group, bool invert=false, bool drop=true) |
Delete points that are members of a group. More... | |
void | deleteMissingPointGroups (std::vector< std::string > &groups, const AttributeSet::Descriptor &descriptor) |
Delete any group that is not present in the Descriptor. More... | |
template<typename PointDataTree > | |
void | appendGroup (PointDataTree &tree, const Name &group) |
Appends a new empty group to the VDB tree. More... | |
template<typename PointDataTree > | |
void | appendGroups (PointDataTree &tree, const std::vector< Name > &groups) |
Appends new empty groups to the VDB tree. More... | |
template<typename PointDataTree > | |
void | dropGroup (PointDataTree &tree, const Name &group, const bool compact=true) |
Drops an existing group from the VDB tree. More... | |
template<typename PointDataTree > | |
void | dropGroups (PointDataTree &tree, const std::vector< Name > &groups) |
Drops existing groups from the VDB tree, the tree is compacted after dropping. More... | |
template<typename PointDataTree > | |
void | dropGroups (PointDataTree &tree) |
Drops all existing groups from the VDB tree, the tree is compacted after dropping. More... | |
template<typename PointDataTree > | |
void | compactGroups (PointDataTree &tree) |
Compacts existing groups of a VDB Tree to use less memory if possible. More... | |
template<typename PointDataTree , typename PointIndexTree > | |
void | setGroup (PointDataTree &tree, const PointIndexTree &indexTree, const std::vector< short > &membership, const Name &group, const bool remove=false) |
Sets group membership from a PointIndexTree-ordered vector. More... | |
template<typename PointDataTree > | |
void | setGroup (PointDataTree &tree, const Name &group, const bool member=true) |
Sets membership for the specified group for all points (on/off). More... | |
template<typename PointDataTree , typename FilterT > | |
void | setGroupByFilter (PointDataTree &tree, const Name &group, const FilterT &filter) |
Sets group membership based on a provided filter. More... | |
template<typename PointDataTreeT > | |
void | appendGroup (PointDataTreeT &tree, const Name &group) |
template<typename PointDataTree > | |
void | setGroupByRandomTarget (PointDataTree &tree, const Name &group, const Index64 targetPoints, const unsigned int seed=0) |
template<typename PointDataTree > | |
void | setGroupByRandomPercentage (PointDataTree &tree, const Name &group, const float percentage=10.0f, const unsigned int seed=0) |
template<typename PointDataGridT , typename MaskT = typename PointDataGridT::template ValueConverter<bool>::Type, typename FilterT = NullFilter> | |
std::enable_if< std::is_same < typename MaskT::ValueType, bool >::value, typename MaskT::Ptr >::type | convertPointsToMask (const PointDataGridT &grid, const FilterT &filter=NullFilter(), bool threaded=true) |
Extract a Mask Grid from a Point Data Grid. More... | |
template<typename PointDataGridT , typename MaskT = typename PointDataGridT::template ValueConverter<bool>::Type, typename FilterT = NullFilter> | |
std::enable_if< std::is_same < typename MaskT::ValueType, bool >::value, typename MaskT::Ptr >::type | convertPointsToMask (const PointDataGridT &grid, const openvdb::math::Transform &transform, const FilterT &filter=NullFilter(), bool threaded=true) |
Extract a Mask Grid from a Point Data Grid using a new transform. More... | |
template<typename PointDataGridT , typename DeformerT , typename FilterT = NullFilter> | |
void | movePoints (PointDataGridT &points, DeformerT &deformer, const FilterT &filter=NullFilter(), future::Advect *objectNotInUse=nullptr, bool threaded=true) |
Move points in a PointDataGrid using a custom deformer. More... | |
template<typename PointDataGridT , typename DeformerT , typename FilterT = NullFilter> | |
void | movePoints (PointDataGridT &points, const math::Transform &transform, DeformerT &deformer, const FilterT &filter=NullFilter(), future::Advect *objectNotInUse=nullptr, bool threaded=true) |
Move points in a PointDataGrid using a custom deformer and a new transform. More... | |
template<typename PointDataGridT , typename SourceGridT , typename FilterT = NullFilter, typename InterrupterT = util::NullInterrupter> | |
void | pointSample (PointDataGridT &points, const SourceGridT &sourceGrid, const Name &targetAttribute="", const FilterT &filter=NullFilter(), InterrupterT *const interrupter=nullptr) |
Performs closest point sampling from a VDB grid onto a VDB Points attribute. More... | |
template<typename PointDataGridT , typename SourceGridT , typename FilterT = NullFilter, typename InterrupterT = util::NullInterrupter> | |
void | boxSample (PointDataGridT &points, const SourceGridT &sourceGrid, const Name &targetAttribute="", const FilterT &filter=NullFilter(), InterrupterT *const interrupter=nullptr) |
Performs tri-linear sampling from a VDB grid onto a VDB Points attribute. More... | |
template<typename PointDataGridT , typename SourceGridT , typename FilterT = NullFilter, typename InterrupterT = util::NullInterrupter> | |
void | quadraticSample (PointDataGridT &points, const SourceGridT &sourceGrid, const Name &targetAttribute="", const FilterT &filter=NullFilter(), InterrupterT *const interrupter=nullptr) |
Performs tri-quadratic sampling from a VDB grid onto a VDB Points attribute. More... | |
template<typename PointDataGridT , typename SourceGridT , typename TargetValueT = DummySampleType, typename SamplerT = SampleWithRounding, typename FilterT = NullFilter, typename InterrupterT = util::NullInterrupter> | |
void | sampleGrid (size_t order, PointDataGridT &points, const SourceGridT &sourceGrid, const Name &targetAttribute, const FilterT &filter=NullFilter(), const SamplerT &sampler=SampleWithRounding(), InterrupterT *const interrupter=nullptr, const bool threaded=true) |
Performs sampling and conversion from a VDB grid onto a VDB Points attribute. More... | |
template<typename GridT , typename RandGenT = std::mt19937, typename PositionArrayT = TypedAttributeArray<Vec3f, NullCodec>, typename PointDataGridT = Grid< typename points::TreeConverter<typename GridT::TreeType>::Type>, typename InterrupterT = util::NullInterrupter> | |
PointDataGridT::Ptr | uniformPointScatter (const GridT &grid, const Index64 count, const unsigned int seed=0, const float spread=1.0f, InterrupterT *interrupter=nullptr) |
The free functions depend on the following class: More... | |
template<typename GridT , typename RandGenT = std::mt19937, typename PositionArrayT = TypedAttributeArray<Vec3f, NullCodec>, typename PointDataGridT = Grid< typename points::TreeConverter<typename GridT::TreeType>::Type>, typename InterrupterT = util::NullInterrupter> | |
PointDataGridT::Ptr | denseUniformPointScatter (const GridT &grid, const float pointsPerVoxel, const unsigned int seed=0, const float spread=1.0f, InterrupterT *interrupter=nullptr) |
Uniformly scatter a fixed number of points per active voxel. If the pointsPerVoxel value provided is a fractional value, each voxel calculates a delta value of how likely it is to contain an extra point. More... | |
template<typename GridT , typename RandGenT = std::mt19937, typename PositionArrayT = TypedAttributeArray<Vec3f, NullCodec>, typename PointDataGridT = Grid< typename points::TreeConverter<typename GridT::TreeType>::Type>, typename InterrupterT = util::NullInterrupter> | |
PointDataGridT::Ptr | nonUniformPointScatter (const GridT &grid, const float pointsPerVoxel, const unsigned int seed=0, const float spread=1.0f, InterrupterT *interrupter=nullptr) |
Non uniformly scatter points per active voxel. The pointsPerVoxel value is used to weight each grids cell value to compute a fixed number of points for every active voxel. If the computed result is a fractional value, each voxel calculates a delta value of how likely it is to contain an extra point. More... | |
using openvdb::OPENVDB_VERSION_NAME::points::ActiveFilter = typedef ValueMaskFilter<true> |
Definition at line 128 of file IndexFilter.h.
using openvdb::OPENVDB_VERSION_NAME::points::GroupAttributeArray = typedef TypedAttributeArray<GroupType, GroupCodec> |
Definition at line 40 of file AttributeGroup.h.
using openvdb::OPENVDB_VERSION_NAME::points::GroupType = typedef uint8_t |
Definition at line 31 of file AttributeSet.h.
using openvdb::OPENVDB_VERSION_NAME::points::InactiveFilter = typedef ValueMaskFilter<false> |
Definition at line 129 of file IndexFilter.h.
using openvdb::OPENVDB_VERSION_NAME::points::OPENVDB_DEPRECATED = typedef Index |
Definition at line 33 of file AttributeArrayString.h.
using openvdb::OPENVDB_VERSION_NAME::points::PointDataGrid = typedef Grid<PointDataTree> |
Point data grid.
Definition at line 189 of file PointDataGrid.h.
using openvdb::OPENVDB_VERSION_NAME::points::PointDataTree = typedef tree::Tree<tree::RootNode<tree::InternalNode<tree::InternalNode <PointDataLeafNode<PointDataIndex32, 3>, 4>, 5>>> |
Point index tree configured to match the default VDB configurations.
Definition at line 185 of file PointDataGrid.h.
using openvdb::OPENVDB_VERSION_NAME::points::StringAttributeArray = typedef TypedAttributeArray<Index, StringCodec<false>> |
Definition at line 57 of file AttributeArrayString.h.
|
inline |
Advect points in a PointDataGrid through a velocity grid.
points | the PointDataGrid containing the points to be advected. |
velocity | a velocity grid to be sampled. |
integrationOrder | the integration scheme to use (1 is forward euler, 4 is runge-kutta 4th) |
dt | delta time. |
timeSteps | number of advection steps to perform. |
advectFilter | an optional advection index filter (moves a subset of the points) |
filter | an optional index filter (deletes a subset of the points) |
cached | caches velocity interpolation for faster performance, disable to use less memory (default is on). |
Definition at line 216 of file PointAdvect.h.
|
inline |
Appends a new attribute to the VDB tree (this method does not require a templated AttributeType)
tree | the PointDataTree to be appended to. |
name | name for the new attribute. |
type | the type of the attibute. |
strideOrTotalSize | the stride of the attribute |
constantStride | if false , stride is interpreted as total size of the array |
defaultValue | metadata default attribute value |
hidden | mark attribute as hidden |
transient | mark attribute as transient |
Definition at line 242 of file PointAttribute.h.
|
inline |
Appends a new attribute to the VDB tree.
tree | the PointDataTree to be appended to. |
name | name for the new attribute |
uniformValue | the initial value of the attribute |
strideOrTotalSize | the stride of the attribute |
constantStride | if false , stride is interpreted as total size of the array |
defaultValue | metadata default attribute value |
hidden | mark attribute as hidden |
transient | mark attribute as transient |
Definition at line 305 of file PointAttribute.h.
|
inline |
Definition at line 543 of file PointAttribute.h.
|
inline |
Definition at line 562 of file PointAttribute.h.
|
inline |
Appends a new empty group to the VDB tree.
tree | the PointDataTree to be appended to. |
group | name of the new group. |
|
inline |
Definition at line 317 of file PointGroup.h.
|
inline |
Appends new empty groups to the VDB tree.
tree | the PointDataTree to be appended to. |
groups | names of the new groups. |
Definition at line 388 of file PointGroup.h.
|
inline |
Performs tri-linear sampling from a VDB grid onto a VDB Points attribute.
points | the PointDataGrid whose points will be sampled on to |
sourceGrid | VDB grid which will be sampled |
targetAttribute | a target attribute on the points which will hold samples. This attribute will be created with the source grid type if it does not exist, and with the source grid name if the name is empty |
filter | an optional index filter |
interrupter | an optional interrupter |
Definition at line 536 of file PointSample.h.
|
inline |
Collapse the attribute into a uniform value.
tree | the PointDataTree in which to collapse the attribute. |
name | name for the attribute. |
uniformValue | value of the attribute |
Definition at line 341 of file PointAttribute.h.
|
inline |
Compact attributes in a VDB tree (if possible).
tree | the PointDataTree. |
Definition at line 524 of file PointAttribute.h.
|
inline |
Compacts existing groups of a VDB Tree to use less memory if possible.
tree | the PointDataTree to be compacted. |
Definition at line 485 of file PointGroup.h.
|
inline |
@ brief Given a container of world space positions and a target points per voxel, compute a uniform voxel size that would best represent the storage of the points in a grid. This voxel size is typically used for conversion of the points into a PointDataGrid.
positions | array of world space positions |
pointsPerVoxel | the target number of points per voxel, must be positive and non-zero |
transform | voxel size will be computed using this optional transform if provided |
decimalPlaces | for readability, truncate voxel size to this number of decimals |
interrupter | an optional interrupter |
Definition at line 870 of file PointConversion.h.
|
inline |
Convert the attribute from a PointDataGrid.
attribute | the attribute to be populated. |
tree | the PointDataTree to be converted. |
pointOffsets | a vector of cumulative point offsets for each leaf. |
startOffset | a value to shift all the point offsets by |
arrayIndex | the index in the Descriptor of the array to be converted. |
stride | the stride of the attribute |
filter | an index filter |
inCoreOnly | true if out-of-core leaf nodes are to be ignored |
Definition at line 810 of file PointConversion.h.
|
inline |
Convert the group from a PointDataGrid.
group | the group to be populated. |
tree | the PointDataTree to be converted. |
pointOffsets | a vector of cumulative point offsets for each leaf |
startOffset | a value to shift all the point offsets by |
index | the group index to be converted. |
filter | an index filter |
inCoreOnly | true if out-of-core leaf nodes are to be ignored |
Definition at line 842 of file PointConversion.h.
|
inline |
Convert the position attribute from a Point Data Grid.
positionAttribute | the position attribute to be populated. |
grid | the PointDataGrid to be converted. |
pointOffsets | a vector of cumulative point offsets for each leaf |
startOffset | a value to shift all the point offsets by |
filter | an index filter |
inCoreOnly | true if out-of-core leaf nodes are to be ignored |
Definition at line 776 of file PointConversion.h.
|
inline |
Extract a Mask Grid from a Point Data Grid.
grid | the PointDataGrid to extract the mask from. |
filter | an optional index filter |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 363 of file PointMask.h.
|
inline |
Extract a Mask Grid from a Point Data Grid using a new transform.
grid | the PointDataGrid to extract the mask from. |
transform | target transform for the mask. |
filter | an optional index filter |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 376 of file PointMask.h.
|
inline |
Localises points with position into a PointDataGrid
into two stages: allocation of the leaf attribute data and population of the positions.
pointIndexGrid | a PointIndexGrid into the points. |
positions | list of world space point positions. |
xform | world to index space transform. |
positionDefaultValue | metadata default position value |
PointIndexGrid
to the points must be supplied to perform this operation. Typically this is built implicitly by the PointDataGrid constructor. Definition at line 616 of file PointConversion.h.
|
inline |
Convenience method to create a PointDataGrid
from a std::vector of point positions.
positions | list of world space point positions. |
xform | world to index space transform. |
positionDefaultValue | metadata default position value |
PointIndexGrid
to the points. Definition at line 721 of file PointConversion.h.
|
inline |
Definition at line 1049 of file PointConversion.h.
|
inline |
Definition at line 1062 of file PointConversion.h.
|
inline |
Delete points that are members of a group.
This method will delete points which are members of the supplied group and will optionally drop the group from the tree. An invert flag can be used to delete points that belong to none of the groups.
pointTree | the point tree with the group to delete |
group | the name of the group to delete |
invert | if enabled, points not belonging to any of the groups will be deleted |
drop | if enabled and invert is disabled, the group will be dropped from the tree |
Definition at line 263 of file PointDelete.h.
|
inline |
Delete points that are members of specific groups.
This method will delete points which are members of any of the supplied groups and will optionally drop the groups from the tree. An invert flag can be used to delete points that belong to none of the groups.
pointTree | the point tree |
groups | the groups from which to delete points |
invert | if enabled, points not belonging to any of the groups will be deleted |
drop | if enabled and invert is disabled, the groups will be dropped from the tree |
Definition at line 208 of file PointDelete.h.
|
inline |
Delete any group that is not present in the Descriptor.
groups | the vector of group names. |
descriptor | the descriptor that holds the group map. |
Definition at line 303 of file PointGroup.h.
|
inline |
Uniformly scatter a fixed number of points per active voxel. If the pointsPerVoxel value provided is a fractional value, each voxel calculates a delta value of how likely it is to contain an extra point.
grid | A source grid. The resulting PointDataGrid will copy this grids transform and scatter in its active voxelized topology. |
pointsPerVoxel | The number of points to scatter per voxel |
seed | A seed for the RandGenT |
spread | The spread of points as a scale from each voxels center. A value of 1.0f indicates points can be placed anywhere within the voxel, where as a value of 0.0f will force all points to be created exactly at the centers of each voxel. |
interrupter | An optional interrupter |
Definition at line 394 of file PointScatter.h.
|
inline |
Drop one attribute from the VDB tree (convenience method).
tree | the PointDataTree to be dropped from. |
index | index of the attribute to drop. |
Definition at line 444 of file PointAttribute.h.
|
inline |
Drop one attribute from the VDB tree (convenience method).
tree | the PointDataTree to be dropped from. |
name | name of the attribute to drop. |
Definition at line 453 of file PointAttribute.h.
|
inline |
Drops attributes from the VDB tree.
tree | the PointDataTree to be dropped from. |
indices | indices of the attributes to drop. |
Definition at line 377 of file PointAttribute.h.
|
inline |
Drops attributes from the VDB tree.
tree | the PointDataTree to be dropped from. |
names | names of the attributes to drop. |
Definition at line 412 of file PointAttribute.h.
|
inline |
Drops an existing group from the VDB tree.
tree | the PointDataTree to be dropped from. |
group | name of the group. |
compact | compact attributes if possible to reduce memory - if dropping more than one group, compacting once at the end will be faster |
Definition at line 404 of file PointGroup.h.
|
inline |
Drops existing groups from the VDB tree, the tree is compacted after dropping.
tree | the PointDataTree to be dropped from. |
groups | names of the groups. |
Definition at line 437 of file PointGroup.h.
|
inline |
Drops all existing groups from the VDB tree, the tree is compacted after dropping.
tree | the PointDataTree to be dropped from. |
Definition at line 454 of file PointGroup.h.
|
inline |
Definition at line 61 of file AttributeArray.h.
|
inline |
Definition at line 79 of file AttributeArray.h.
|
inline |
Definition at line 50 of file AttributeArray.h.
|
inline |
Definition at line 69 of file AttributeArray.h.
|
inline |
Definition at line 63 of file AttributeGroup.h.
|
inline |
Definition at line 152 of file AttributeArrayString.h.
|
inline |
Count up the number of times the iterator can iterate.
iter | the iterator. |
Definition at line 314 of file IndexIterator.h.
|
inline |
Deep copy the descriptor across all leaf nodes.
tree | the PointDataTree. |
Definition at line 1589 of file PointDataGrid.h.
|
inline |
Move points in a PointDataGrid using a custom deformer.
points | the PointDataGrid containing the points to be moved. |
deformer | a custom deformer that defines how to move the points. |
filter | an optional index filter |
objectNotInUse | for future use, this object is currently ignored |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 1086 of file PointMove.h.
|
inline |
Move points in a PointDataGrid using a custom deformer and a new transform.
points | the PointDataGrid containing the points to be moved. |
transform | target transform to use for the resulting points. |
deformer | a custom deformer that defines how to move the points. |
filter | an optional index filter |
objectNotInUse | for future use, this object is currently ignored |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 896 of file PointMove.h.
|
inline |
Non uniformly scatter points per active voxel. The pointsPerVoxel value is used to weight each grids cell value to compute a fixed number of points for every active voxel. If the computed result is a fractional value, each voxel calculates a delta value of how likely it is to contain an extra point.
grid | A source grid. The resulting PointDataGrid will copy this grids transform, voxelized topology and use its values to compute a target points per voxel. The grids ValueType must be convertible to a scalar value. Only active and larger than zero values will contain points. |
pointsPerVoxel | The number of points to scatter per voxel |
seed | A seed for the RandGenT |
spread | The spread of points as a scale from each voxels center. A value of 1.0f indicates points can be placed anywhere within the voxel, where as a value of 0.0f will force all points to be created exactly at the centers of each voxel. |
interrupter | An optional interrupter |
Definition at line 476 of file PointScatter.h.
|
inline |
Count the total number of points in a PointDataTree.
tree | the PointDataTree in which to count the points |
filter | an optional index filter |
inCoreOnly | if true, points in out-of-core leaf nodes are not counted |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 88 of file PointCount.h.
|
inline |
Generate a new grid with voxel values to store the number of points per voxel.
grid | the PointDataGrid to use to compute the count grid |
filter | an optional index filter |
Definition at line 164 of file PointCount.h.
|
inline |
Generate a new grid that uses the supplied transform with voxel values to store the number of points per voxel.
grid | the PointDataGrid to use to compute the count grid |
transform | the transform to use to compute the count grid |
filter | an optional index filter |
Definition at line 182 of file PointCount.h.
|
inline |
Populate an array of cumulative point offsets per leaf node.
pointOffsets | array of offsets to be populated |
tree | the PointDataTree from which to populate the offsets |
filter | an optional index filter |
inCoreOnly | if true, points in out-of-core leaf nodes are ignored |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 122 of file PointCount.h.
|
inline |
Performs closest point sampling from a VDB grid onto a VDB Points attribute.
points | the PointDataGrid whose points will be sampled on to |
sourceGrid | VDB grid which will be sampled |
targetAttribute | a target attribute on the points which will hold samples. This attribute will be created with the source grid type if it does not exist, and with the source grid name if the name is empty |
filter | an optional index filter |
interrupter | an optional interrupter |
Definition at line 525 of file PointSample.h.
|
inline |
Stores point attribute data in an existing PointDataGrid
attribute.
tree | the PointDataGrid to be populated. |
pointIndexTree | a PointIndexTree into the points. |
attributeName | the name of the VDB Points attribute to be populated. |
data | a wrapper to the attribute data. |
stride | the stride of the attribute |
insertMetadata | true if strings are to be automatically inserted as metadata. |
PointIndexGrid
to the points must be supplied to perform this operation. This is required to ensure the same point index ordering. Definition at line 739 of file PointConversion.h.
|
inline |
Sequentially pre-fetch all delayed-load voxel and attribute data from disk in order to accelerate subsequent random access.
tree | the PointDataTree. |
position | if enabled, prefetch the position attribute (default is on) |
otherAttributes | if enabled, prefetch all other attributes (default is on) |
Definition at line 1619 of file PointDataGrid.h.
|
inline |
Performs tri-quadratic sampling from a VDB grid onto a VDB Points attribute.
points | the PointDataGrid whose points will be sampled on to |
sourceGrid | VDB grid which will be sampled |
targetAttribute | a target attribute on the points which will hold samples. This attribute will be created with the source grid type if it does not exist, and with the source grid name if the name is empty |
filter | an optional index filter |
interrupter | an optional interrupter |
Definition at line 547 of file PointSample.h.
|
inline |
Rename an attribute in a VDB tree.
tree | the PointDataTree. |
oldName | the old attribute name to rename from. |
newName | the new attribute name to rename to. |
Definition at line 512 of file PointAttribute.h.
|
inline |
Rename attributes in a VDB tree.
tree | the PointDataTree. |
oldNames | a list of old attribute names to rename from. |
newNames | a list of new attribute names to rename to. |
Definition at line 465 of file PointAttribute.h.
|
inline |
Performs sampling and conversion from a VDB grid onto a VDB Points attribute.
order | the sampling order - 0 = closest-point, 1 = trilinear, 2 = triquadratic |
points | the PointDataGrid whose points will be sampled on to |
sourceGrid | VDB grid which will be sampled |
targetAttribute | a target attribute on the points which will hold samples. This attribute will be created with the source grid type if it does not exist, and with the source grid name if the name is empty |
filter | an optional index filter |
sampler | handles sampling and conversion into the target attribute type, which by default this uses the SampleWithRounding struct. |
interrupter | an optional interrupter |
threaded | enable or disable threading (threading is enabled by default) |
Definition at line 427 of file PointSample.h.
|
inline |
Sets group membership from a PointIndexTree-ordered vector.
tree | the PointDataTree. |
indexTree | the PointIndexTree. |
membership | 1 if the point is in the group, 0 otherwise. |
group | the name of the group. |
remove | if true also perform removal of points from the group. |
Definition at line 546 of file PointGroup.h.
|
inline |
Sets membership for the specified group for all points (on/off).
tree | the PointDataTree. |
group | the name of the group. |
member | true / false for membership of the group. |
Definition at line 616 of file PointGroup.h.
|
inline |
Sets group membership based on a provided filter.
tree | the PointDataTree. |
group | the name of the group. |
filter | filter data that is used to create a per-leaf filter |
Definition at line 650 of file PointGroup.h.
|
inline |
Definition at line 702 of file PointGroup.h.
|
inline |
Definition at line 685 of file PointGroup.h.
|
inline |
Toggle the streaming mode on all attributes in the tree to collapse the attributes after deconstructing a bound AttributeHandle to each array. This results in better memory efficiency when the data is streamed into another data structure (typically for rendering).
tree | the PointDataTree. |
on | true to enable streaming |
Definition at line 1606 of file PointDataGrid.h.
|
inline |
The free functions depend on the following class:
The InterrupterT
template argument below refers to any class with the following interface:
grid | A source grid. The resulting PointDataGrid will copy this grids transform and scatter in its active voxelized topology. |
count | The total number of points to scatter |
seed | A seed for the RandGenT |
spread | The spread of points as a scale from each voxels center. A value of 1.0f indicates points can be placed anywhere within the voxel, where as a value of 0.0f will force all points to be created exactly at the centers of each voxel. |
interrupter | An optional interrupter |
Get the prefixed voxel counts for each leaf node with an additional value to represent the end voxel count. See also LeafManager::getPrefixSum()
Get the prefixed voxel counts for each leaf node with an additional value to represent the end voxel count. See also LeafManager::getPrefixSum()
Definition at line 222 of file PointScatter.h.