HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HUSD_GeoSubset Class Reference

#include <HUSD_GeoSubset.h>

Public Types

enum  FamilyType { FamilyType::UNRESTRICTED, FamilyType::NONOVERLAPPING, FamilyType::PARTITION }
 Enumerates the possible values for geo subset family type. More...
 

Public Member Functions

 HUSD_GeoSubset (HUSD_AutoWriteLock &lock)
 Standard constructor. More...
 
bool createGeoSubset (const UT_StringRef &prim_path, const UT_ExintArray &face_indices, const UT_StringRef &subset_name) const
 Creates geometry subset in a given primitive. More...
 
void setFamilyType (FamilyType type)
 
FamilyType getFamilyType () const
 
bool getGeoPrimitiveAndFaceIndices (UT_StringHolder &geo_prim_path, UT_ExintArray &face_indices, const UT_StringRef &subset_prim_path, const HUSD_TimeCode &time_code) const
 
void setFamilyName (const UT_StringRef &name)
 
const UT_StringHoldergetFamilyName () const
 

Detailed Description

Definition at line 27 of file HUSD_GeoSubset.h.

Member Enumeration Documentation

Enumerates the possible values for geo subset family type.

Enumerator
UNRESTRICTED 
NONOVERLAPPING 
PARTITION 

Definition at line 49 of file HUSD_GeoSubset.h.

Constructor & Destructor Documentation

HUSD_GeoSubset::HUSD_GeoSubset ( HUSD_AutoWriteLock lock)

Standard constructor.

Member Function Documentation

bool HUSD_GeoSubset::createGeoSubset ( const UT_StringRef prim_path,
const UT_ExintArray face_indices,
const UT_StringRef subset_name 
) const

Creates geometry subset in a given primitive.

const UT_StringHolder& HUSD_GeoSubset::getFamilyName ( ) const
inline

Get and set the geometry subset family name. The subsets that have the same family name are logically tied together, and can be validated for overlaps, partitioning, etc.

Definition at line 44 of file HUSD_GeoSubset.h.

FamilyType HUSD_GeoSubset::getFamilyType ( ) const
inline

Definition at line 57 of file HUSD_GeoSubset.h.

bool HUSD_GeoSubset::getGeoPrimitiveAndFaceIndices ( UT_StringHolder geo_prim_path,
UT_ExintArray face_indices,
const UT_StringRef subset_prim_path,
const HUSD_TimeCode time_code 
) const

Returns true if the subset_prim_path refers to a geometry subset, and if so also returns the geometry parent path and face idices. Otherwise, returns false.

void HUSD_GeoSubset::setFamilyName ( const UT_StringRef name)
inline

Get and set the geometry subset family name. The subsets that have the same family name are logically tied together, and can be validated for overlaps, partitioning, etc.

Definition at line 42 of file HUSD_GeoSubset.h.

void HUSD_GeoSubset::setFamilyType ( FamilyType  type)
inline

Definition at line 55 of file HUSD_GeoSubset.h.


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