HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
GA_VertexGroup Class Referencefinal

#include <GA_ElementGroup.h>

+ Inheritance diagram for GA_VertexGroup:

Public Member Functions

 GA_VertexGroup (const GA_Detail &detail)
 Makes a detached vertex group. More...
 
GA_VertexGroupoperator|= (const GA_VertexGroup &g)
 
GA_VertexGroupoperator&= (const GA_VertexGroup &g)
 
GA_VertexGroupoperator-= (const GA_VertexGroup &g)
 
GA_VertexGroupoperator^= (const GA_VertexGroup &g)
 
GA_VertexGroupoperator= (const GA_VertexGroup &g)
 
- Public Member Functions inherited from GA_ElementGroup
virtual const GA_DetailgetDetail () const final
 
GA_DetailgetDetail ()
 
 GA_ElementGroup (const GA_Detail &detail, GA_AttributeOwner owner)
 
virtual ~GA_ElementGroup ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
virtual void countMemory (UT_MemoryCounter &counter, bool inclusive) const
 
virtual bool isOrdered () const final
 Returns true if the group is currently ordered. More...
 
bool setOrdered (bool ordered)
 
void makeOrdered ()
 
void makeUnordered ()
 
void clearOrdered ()
 Clear all order information, including any mixed entries. More...
 
bool copyMembership (const GA_ATIGroupBool &src, bool copy_ordering=true)
 
GA_Offset findOffsetAtGroupIndex (GA_Size i) const
 
SYS_FORCE_INLINE void setElement (GA_Offset ai, bool v)
 
SYS_FORCE_INLINE void setElement (const GA_Range &it, bool v)
 NOTE: This cannot be used in parallel on an ordered group. More...
 
void toggleElement (GA_Offset ai)
 
void toggleElement (const GA_Range &it)
 NOTE: This cannot be used in parallel on an ordered group. More...
 
virtual bool combine (const GA_Group *src) final
 
GA_ElementGroupoperator|= (const GA_ElementGroup &g)
 
SYS_FORCE_INLINE bool contains (GA_Offset offset) const
 
bool containsIndex (GA_Index ai) const
 
SYS_FORCE_INLINE bool containsOffset (GA_Offset offset) const
 
SYS_FORCE_INLINE bool containsAny (const GA_Range &range) const
 
SYS_FORCE_INLINE bool isGroupEmpty () const
 
SYS_FORCE_INLINE bool isEmpty () const
 Query whether the group is empty of primary elements. More...
 
bool isEmptyMix () const
 Query whether the group is empty of elements, primary or mixed. More...
 
virtual GA_Size entries () const final
 Will return the number of primary elements. More...
 
virtual GA_Size entriesMix () const final
 Will return the total number of elements, primary and mixed. More...
 
GA_Size getGroupEntries () const
 
GA_Size computeGroupEntries () const
 
virtual bool isMixed () const final
 Query if the group contains any mixed elements. More...
 
SYS_FORCE_INLINE void setOffset (GA_Offset ai, bool v)
 
void getConstantSpan (GA_Offset start, GA_Offset end, GA_Size &size, bool &value) const
 
void clear ()
 
void makeConstant (bool value)
 
void invalidateGroupEntries ()
 
virtual bool needDestruction () const
 Methods which can be overridden from GA_Attribute. More...
 
virtual void destructElement (GA_Offset offset)
 Callback invoked if needsDestruction() returns true. More...
 
virtual void reconstructElementBlock (GA_Offset offset, GA_Offset nelements)
 
virtual void addAll () final
 Add all elements to the group. More...
 
void setEntries ()
 Add all elements to the group, only writing to real elements' offsets. More...
 
void toggleEntries ()
 Toggle membership of all elements. More...
 
virtual WriteConcurrence getSupportedWriteConcurrence () const
 
virtual const GA_AIFCopyDatagetAIFCopyData () const
 Return the attribute's copy interface or NULL. More...
 
virtual const GA_AIFTuplegetAIFTuple () const
 Return the attribute's tuple interface or NULL. More...
 
virtual const GA_AIFInterp * getAIFInterp () const
 Return the attribute's interpolation interface or NULL. More...
 
virtual const GA_AIFMergegetAIFMerge () const
 Return the attribute's merge interface or NULL. More...
 
GA_ElementGroupOrdergetOrdered ()
 
const GA_ElementGroupOrdergetOrdered () const
 
GA_ElementGroupgetGroup ()
 
const GA_ElementGroupgetGroup () const
 
GA_ElementGroupgetAttribute ()
 
const GA_ElementGroupgetAttribute () const
 
bool loadGroupH9 (UT_IStream &is)
 
bool loadGroupByIndexOrderH9 (const UT_BitArray &array)
 
bool saveGroupH9 (std::ostream &os, bool binary) const
 
virtual bool debugValidateArrayCapacity (GA_Offset sz) const
 Debug validation of allocated array size. More...
 
bool jsonSave (UT_JSONWriter &w, const GA_SaveMap &map) const
 
bool jsonLoad (UT_JSONParser &p, const GA_LoadMap &map)
 Load from a JSON stream. More...
 
virtual bool jsonSaveData (UT_JSONWriter &w, const GA_SaveMap &map) const
 
virtual bool jsonLoadData (UT_JSONParser &p, const GA_LoadMap &map)
 Load from a JSON stream. More...
 
virtual bool stat (UT_WorkBuffer &info, uint level) const
 Compute detailed information. More...
 
virtual bool setArraySize (GA_Offset new_size)
 Grow or shrink the array size. More...
 
GA_Offset getArraySize () const
 
SYS_FORCE_INLINE GA_DataBitArraygetData ()
 
SYS_FORCE_INLINE const
GA_DataBitArray
getData () const
 Returns the read-only raw bit array. More...
 
SYS_FORCE_INLINE bool isPageConstant (GA_PageNum pagenum) const
 
SYS_FORCE_INLINE bool getPageValue (GA_PageNum pagenum) const
 
SYS_FORCE_INLINE void setPageConstant (GA_PageNum pagenum, const bool value)
 Sets all elements of the specified page to the given value. More...
 
virtual void tryCompressAllPages (GA_Offset start_offset=GA_Offset(0), GA_Offset end_offset=GA_INVALID_OFFSET)
 Try to compress data pages. More...
 
virtual void hardenAllPages (GA_Offset start_offset=GA_Offset(0), GA_Offset end_offset=GA_INVALID_OFFSET)
 Harden data pages. More...
 
virtual void copyNonStorageMetadata (const GA_Attribute *that) final
 
virtual void replace (const GA_Attribute &src) final
 
virtual void defragment (const GA_Defragment &defrag)
 
void orEqual (const GA_ATIGroupBool *src)
 
void andEqual (const GA_ATIGroupBool *src)
 
void xorEqual (const GA_ATIGroupBool *src)
 
void subEqual (const GA_ATIGroupBool *src)
 
void toggleAll (GA_Size numelements)
 
GA_ElementGroupoperator&= (const GA_ElementGroup &g)
 
GA_ElementGroupoperator-= (const GA_ElementGroup &g)
 
GA_ElementGroupoperator^= (const GA_ElementGroup &g)
 
GA_ElementGroupoperator= (const GA_ElementGroup &g)
 
SYS_FORCE_INLINE void addIndex (GA_Index ai)
 
SYS_FORCE_INLINE void toggleIndex (GA_Index ai)
 
SYS_FORCE_INLINE void removeIndex (GA_Index ai)
 
SYS_FORCE_INLINE void addOffset (GA_Offset ai)
 
SYS_FORCE_INLINE void toggleOffset (GA_Offset ai)
 
SYS_FORCE_INLINE void removeOffset (GA_Offset ai)
 
SYS_FORCE_INLINE void addRange (const GA_Range &it)
 
SYS_FORCE_INLINE void toggleRange (const GA_Range &it)
 
SYS_FORCE_INLINE void removeRange (const GA_Range &it)
 
virtual bool copy (GA_Offset desti, GA_Offset srci) final
 
virtual bool copy (GA_Offset desti, const GA_Attribute &src, GA_Offset srci) final
 
bool copy (GA_Offset desti, const GA_ATIGroupBool &src, GA_Offset srci)
 
virtual bool copy (const GA_Range &destrange, const GA_Range &srcrange) final
 
virtual bool copy (const GA_Range &destrange, const GA_Attribute &src, const GA_Range &srcrange) final
 
bool copy (const GA_Range &destrange, const GA_ATIGroupBool &src, const GA_Range &srcrange)
 
virtual bool fill (const GA_Range &destrange, GA_Offset srci) final
 
virtual bool fill (const GA_Range &destrange, const GA_Attribute &src, GA_Offset srci) final
 
bool fill (const GA_Range &destrange, const GA_ATIGroupBool &src, GA_Offset srci)
 
- Public Member Functions inherited from GA_Attribute
 GA_Attribute (const GA_AttributeType &type, const GA_IndexMap &index_map, GA_AttributeScope scope, const UT_StringHolder &name)
 
virtual ~GA_Attribute ()
 
const GA_AttributeTypegetType () const
 
const GA_IndexMapgetIndexMap () const
 
const GA_DetailgetDetail () const
 
GA_DetailgetDetail ()
 
GA_AttributeOwner getOwner () const
 
GA_AttributeScope getScope () const
 
SYS_FORCE_INLINE GA_TypeInfo getTypeInfo () const
 
SYS_FORCE_INLINE void setTypeInfo (GA_TypeInfo type)
 
bool shouldInterpretAsTexCoord (bool allow_float2=false) const
 
GA_StorageClass getStorageClass () const
 Returns the approximate type of the attribute. More...
 
int getTupleSize () const
 Size of the AIFTuple, if it exists. If it doesn't, 1. More...
 
const UT_StringHoldergetName () const
 
const UT_StringHoldergetFullName () const
 
SYS_FORCE_INLINE GA_DataId getDataId () const
 
SYS_FORCE_INLINE void assignNewDataId ()
 
SYS_FORCE_INLINE void bumpDataId ()
 
SYS_FORCE_INLINE void clearDataId ()
 
SYS_FORCE_INLINE void cloneDataId (const GA_Attribute &src, bool allow_clear=false)
 
SYS_FORCE_INLINE void cloneOrBumpDataId (const GA_Attribute &src, bool allow_clear=false)
 NOTE: Just call cloneDataId(src). More...
 
virtual const GA_AIFDeltagetAIFDelta () const
 Return the attribute's delta interface or NULL. More...
 
virtual const GA_AIFMathgetAIFMath () const
 Return the attribute's math interface or NULL. More...
 
virtual const GA_AIFBlobgetAIFBlob () const
 Return the attribute's blob interface or NULL. More...
 
virtual const GA_AIFBlobArraygetAIFBlobArray () const
 Return the attribute's blob array interface or NULL. More...
 
virtual const GA_AIFStringTuplegetAIFStringTuple () const
 Return the attribute's string tuple interface or NULL. More...
 
virtual const
GA_AIFSharedStringTuple
getAIFSharedStringTuple () const
 Return the attribute's shared string tuple interface or NULL. More...
 
virtual const
GA_AIFSharedStringArray
getAIFSharedStringArray () const
 Return the attribute's shared string array interface or NULL. More...
 
virtual const GA_AIFIndexPairgetAIFIndexPair () const
 Return the attribute's index pair interface or NULL. More...
 
virtual const GA_AIFBlindDatagetAIFBlindData () const
 Return the attribute's blind data interface or NULL. More...
 
virtual const GA_AIFEditgetAIFEdit () const
 Return the attribute's edit interface or NULL. More...
 
virtual const GA_AIFComparegetAIFCompare () const
 Return the attribute's comparison interface or NULL. More...
 
virtual const GA_AIFNumericArraygetAIFNumericArray () const
 Return the attribute's arraydata interface or NULL. More...
 
virtual const GA_AIFStatgetAIFStat () const
 
template<typename T >
const TgetAIF () const
 Generic method for getting an AIF by type. More...
 
const GA_AttributeOptionsgetOptions () const
 
GA_AttributeOptionsgetOptions ()
 
void setNonTransforming (bool val)
 
bool needsTransform (bool include_P=true) const
 
bool isDetached () const
 
void mergeOptions (const GA_AttributeOptions &src)
 Merge the options passed in with the options in the attribute. More...
 
bool importOption (const char *name, int &v) const
 
bool importOption (const char *name, bool &v) const
 
bool importOption (const char *name, fpreal32 &v) const
 
bool importOption (const char *name, fpreal64 &v) const
 
bool importOption (const char *name, UT_String &v) const
 
void setTailInitialization (bool onoff)
 
bool isTailInitialization () const
 Check whether the attribute is set to tail initialization. More...
 
void reconstructElement (GA_Offset offset)
 
virtual void compactStorage ()
 
virtual void batchDeletion ()
 
GA_Attributeclone (const GA_IndexMap &index_map, const UT_StringHolder &name, bool clone_options) const
 
bool jsonSaveDefinition (UT_JSONWriter &w) const
 Save the GA_Attribute-Definition section. More...
 
virtual const GA_AIFJSONgetAIFJSON () const
 Return the AIF to handle saving/loading of the private data section. More...
 
virtual int getSaveVersion () const
 
virtual bool matchesStorage (const GA_Attribute *that) const
 
GA_AttributeProxyHandle getProxy ()
 
GA_ConstAttributeProxyHandle getProxy () const
 
void setExportName (const char *external_name)
 
bool hasExportName () const
 
std::string getExportName () const
 
GA_CEAttributegetCEAttribute (GA_StorageClass storage, int &tuplesize, bool isarray, bool read, bool write)
 
void flushCEWriteCaches (bool clearwriteback=true)
 
bool hasPendingCEWriteBack () const
 
void flushCECaches ()
 Remove all CE Caches, copying back any marked as written to. More...
 
- Public Member Functions inherited from GA_Group
virtual ~GA_Group ()
 
const UT_StringHoldergetName () const
 
bool isInternal () const
 
bool getInternal () const
 
void setInternal (bool onOff)
 
bool isDetached () const
 
GA_GroupType classType (void) const
 
GA_GroupMaskType classMaskType () const
 
bool isElementGroup () const
 
SYS_FORCE_INLINE bool isEmpty () const
 
void clearEntries ()
 
virtual bool jsonShouldSave (const GA_SaveMap &map) const
 
bool jsonSaveDefinition (UT_JSONWriter &w, const char *type) const
 
void dump (std::ostream &os)
 A convenience function to do a JSON dump of the group contents. More...
 

Protected Member Functions

 GA_VertexGroup (GA_Detail &detail, const UT_StringHolder &name, bool internal, bool detached)
 
- Protected Member Functions inherited from GA_ElementGroup
 GA_ElementGroup (GA_Detail &detail, GA_AttributeOwner owner, const UT_StringHolder &name, bool internal, bool detached)
 
- Protected Member Functions inherited from GA_Attribute
int64 getBaseMemoryUsage () const
 
void setDetached (bool detached)
 Only called by GA_AttributeSet and GA_ElementGroup. More...
 
- Protected Member Functions inherited from GA_Group
 GA_Group (const UT_StringHolder &name, bool internal, GA_GroupType type, bool detached)
 

Friends

class GA_GroupTable
 
class GA_ElementGroupTable
 
class GA_ElementGroupTableT< GA_ATTRIB_VERTEX >
 

Additional Inherited Members

- Public Types inherited from GA_Attribute
enum  WriteConcurrence { WRITE_CONCURRENCE_NONE, WRITE_CONCURRENCE_PAGE, WRITE_CONCURRENCE_ELEMENT }
 
- Static Public Member Functions inherited from GA_ElementGroup
static void registerType ()
 
static SYS_FORCE_INLINE const
UT_StringHolder
getTypeName ()
 
static SYS_FORCE_INLINE const
GA_AttributeType
getType ()
 
static SYS_FORCE_INLINE bool isType (const GA_Attribute *attrib)
 
static SYS_FORCE_INLINE
GA_ATIGroupBool
cast (GA_Attribute *attrib)
 
static SYS_FORCE_INLINE const
GA_ATIGroupBool
cast (const GA_Attribute *attrib)
 
static SYS_FORCE_INLINE bool isType (const GA_Group *group)
 
static SYS_FORCE_INLINE const
GA_ElementGroup
cast (const GA_Group *group)
 
static SYS_FORCE_INLINE
GA_ElementGroup
cast (GA_Group *group)
 
- Static Public Member Functions inherited from GA_Attribute
static bool jsonLoadDefinition (UT_JSONParser &p, GA_AttributeScope &scope, UT_WorkBuffer &type, UT_WorkBuffer &name, int64 &version, GA_AttributeOptions &options)
 Load the GA_Attribute-Definition section. More...
 
static GA_DataId nextDataId ()
 
- Static Public Member Functions inherited from GA_Group
static const char * groupType (GA_GroupType type)
 
static GA_GroupType groupType (const char *type)
 
static bool jsonLoadDefinition (UT_JSONParser &p, UT_WorkBuffer &type, UT_WorkBuffer &name, bool &internal)
 Load the GA_Group-Definition. More...
 

Detailed Description

Definition at line 160 of file GA_ElementGroup.h.

Constructor & Destructor Documentation

GA_VertexGroup::GA_VertexGroup ( GA_Detail detail,
const UT_StringHolder name,
bool  internal,
bool  detached 
)
inlineprotected

Definition at line 163 of file GA_ElementGroup.h.

GA_VertexGroup::GA_VertexGroup ( const GA_Detail detail)
inline

Makes a detached vertex group.

Definition at line 169 of file GA_ElementGroup.h.

Member Function Documentation

GA_VertexGroup& GA_VertexGroup::operator&= ( const GA_VertexGroup g)
inline

Definition at line 176 of file GA_ElementGroup.h.

GA_VertexGroup& GA_VertexGroup::operator-= ( const GA_VertexGroup g)
inline

Definition at line 180 of file GA_ElementGroup.h.

GA_VertexGroup& GA_VertexGroup::operator= ( const GA_VertexGroup g)
inline

Definition at line 188 of file GA_ElementGroup.h.

GA_VertexGroup& GA_VertexGroup::operator^= ( const GA_VertexGroup g)
inline

Definition at line 184 of file GA_ElementGroup.h.

GA_VertexGroup& GA_VertexGroup::operator|= ( const GA_VertexGroup g)
inline

Definition at line 172 of file GA_ElementGroup.h.

Friends And Related Function Documentation

friend class GA_ElementGroupTable
friend

Definition at line 193 of file GA_ElementGroup.h.

friend class GA_ElementGroupTableT< GA_ATTRIB_VERTEX >
friend

Definition at line 194 of file GA_ElementGroup.h.

friend class GA_GroupTable
friend

Definition at line 192 of file GA_ElementGroup.h.


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