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

Class to return information about a GA_Detail. More...

#include <GA_Stat.h>

Classes

class  ga_StatAttribute
 Simple class to store attribute definition (without data) More...
 
class  ga_StatGroup
 
class  ga_StatVolume
 

Public Member Functions

 GA_Stat ()
 
 ~GA_Stat ()
 
void clear ()
 
const UT_OptionsgetInfoOptions () const
 
void setInfoOptions (const UT_Options &info, const char *bounds_name="bounds")
 
void output (UT_WorkBuffer &buffer, GA_STAT_LEVEL level, bool pretty_print) const
 Common output. More...
 
void outputAttributes (UT_WorkBuffer &buffer, bool pretty_print) const
 Output attribute information only. This appends to the work buffer. More...
 
void outputGroups (UT_WorkBuffer &buffer, bool pretty_print) const
 Output attribute information only. This appends to the work buffer. More...
 
void outputVolumes (UT_WorkBuffer &buffer, bool pretty_print) const
 Output volume information only. This appends to the work buffer. More...
 
GA_Size getPointCount () const
 
GA_Size getVertexCount () const
 
GA_Size getPrimitiveCount () const
 
void setPointCount (GA_Size sz)
 
void setVertexCount (GA_Size sz)
 
void setPrimitiveCount (GA_Size sz)
 
void clearAllAttributes ()
 
void clearAttributes (GA_AttributeOwner owner)
 
void appendAttribute (GA_AttributeOwner owner, const ga_StatAttribute &attrib)
 
GA_Size getAttributeCount (GA_AttributeOwner owner) const
 
const ga_StatAttributegetAttribute (GA_AttributeOwner owner, GA_Size i) const
 
void clearAllGroups ()
 
void clearGroups (GA_GroupType gtype)
 
void appendGroup (GA_GroupType gtype, const ga_StatGroup &group)
 
GA_Size getGroupCount (GA_GroupType gtype) const
 
const ga_StatGroupgetGroup (GA_GroupType gtype, GA_Size i) const
 
void clearPrimitiveTypes ()
 
void appendPrimitive (const UT_StringHolder &type_name)
 
void setPrimitiveCount (const UT_StringHolder &type_name, GA_Size count)
 
GA_Size getPrimitiveTypeCount (const UT_StringRef &type_name) const
 
void getPrimitiveTypes (UT_StringArray &type_names) const
 
void clearVolumes ()
 
void appendVolume (GA_Index idx, const char *name, int rx, int ry, int rz)
 
int getNumVolumes () const
 
const ga_StatVolumegetVolume (int idx) const
 
const UT_BoundingBoxgetBounds () const
 
void setBounds (const UT_BoundingBox &b)
 
void setIO (const GA_IO *io)
 
const GA_IO * getIO () const
 

Detailed Description

Class to return information about a GA_Detail.

This class is filled out by the GA_Detail::stat() methods.

Definition at line 50 of file GA_Stat.h.

Constructor & Destructor Documentation

GA_Stat::GA_Stat ( )
GA_Stat::~GA_Stat ( )

Member Function Documentation

void GA_Stat::appendAttribute ( GA_AttributeOwner  owner,
const ga_StatAttribute attrib 
)
inline

Attribute status. Availability: level >= GA_STAT_NORMAL

Definition at line 196 of file GA_Stat.h.

void GA_Stat::appendGroup ( GA_GroupType  gtype,
const ga_StatGroup group 
)
inline

Group information. Availability: level >= GA_STAT_NORMAL

Definition at line 227 of file GA_Stat.h.

void GA_Stat::appendPrimitive ( const UT_StringHolder type_name)
inline

Primitive interface Availability: level >= GA_STAT_FULL

Definition at line 267 of file GA_Stat.h.

void GA_Stat::appendVolume ( GA_Index  idx,
const char *  name,
int  rx,
int  ry,
int  rz 
)
inline

Volume interface Availability: level >= GA_STAT_FULL

Definition at line 302 of file GA_Stat.h.

void GA_Stat::clear ( )
inline

Definition at line 159 of file GA_Stat.h.

void GA_Stat::clearAllAttributes ( )
inline

Attribute status. Availability: level >= GA_STAT_NORMAL

Definition at line 185 of file GA_Stat.h.

void GA_Stat::clearAllGroups ( )
inline

Group information. Availability: level >= GA_STAT_NORMAL

Definition at line 215 of file GA_Stat.h.

void GA_Stat::clearAttributes ( GA_AttributeOwner  owner)
inline

Attribute status. Availability: level >= GA_STAT_NORMAL

Definition at line 192 of file GA_Stat.h.

void GA_Stat::clearGroups ( GA_GroupType  gtype)
inline

Group information. Availability: level >= GA_STAT_NORMAL

Definition at line 223 of file GA_Stat.h.

void GA_Stat::clearPrimitiveTypes ( )
inline

Primitive interface Availability: level >= GA_STAT_FULL

Definition at line 263 of file GA_Stat.h.

void GA_Stat::clearVolumes ( )
inline

Volume interface Availability: level >= GA_STAT_FULL

Definition at line 298 of file GA_Stat.h.

const ga_StatAttribute& GA_Stat::getAttribute ( GA_AttributeOwner  owner,
GA_Size  i 
) const
inline

Attribute status. Availability: level >= GA_STAT_NORMAL

Definition at line 205 of file GA_Stat.h.

GA_Size GA_Stat::getAttributeCount ( GA_AttributeOwner  owner) const
inline

Attribute status. Availability: level >= GA_STAT_NORMAL

Definition at line 201 of file GA_Stat.h.

const UT_BoundingBox& GA_Stat::getBounds ( ) const
inline

Get bounding box Availability: level >= GA_STAT_FULL

Definition at line 313 of file GA_Stat.h.

const ga_StatGroup& GA_Stat::getGroup ( GA_GroupType  gtype,
GA_Size  i 
) const
inline

Group information. Availability: level >= GA_STAT_NORMAL

Definition at line 235 of file GA_Stat.h.

GA_Size GA_Stat::getGroupCount ( GA_GroupType  gtype) const
inline

Group information. Availability: level >= GA_STAT_NORMAL

Definition at line 231 of file GA_Stat.h.

const UT_Options& GA_Stat::getInfoOptions ( ) const
inline

Get the info block options which were set by the stat() operation Special options that will be used for quick stats (when the stat level is STAT_LEVEL_BRIEF.

  • string primcount_summary
  • string attribute_summary
  • string group_summary If possible, the file format should set these from any header information.

Definition at line 250 of file GA_Stat.h.

const GA_IO* GA_Stat::getIO ( ) const
inline

Set/get the GA_IO which performed the stat

Definition at line 334 of file GA_Stat.h.

int GA_Stat::getNumVolumes ( ) const
inline

Volume interface Availability: level >= GA_STAT_FULL

Definition at line 306 of file GA_Stat.h.

GA_Size GA_Stat::getPointCount ( ) const
inline

Get/Set the number of elements in the detail Availability: level >= GA_STAT_BRIEF

Definition at line 173 of file GA_Stat.h.

GA_Size GA_Stat::getPrimitiveCount ( ) const
inline

Get/Set the number of elements in the detail Availability: level >= GA_STAT_BRIEF

Definition at line 175 of file GA_Stat.h.

GA_Size GA_Stat::getPrimitiveTypeCount ( const UT_StringRef type_name) const
inline

Primitive interface Availability: level >= GA_STAT_FULL

Definition at line 276 of file GA_Stat.h.

void GA_Stat::getPrimitiveTypes ( UT_StringArray type_names) const
inline

Primitive interface Availability: level >= GA_STAT_FULL

Definition at line 283 of file GA_Stat.h.

GA_Size GA_Stat::getVertexCount ( ) const
inline

Get/Set the number of elements in the detail Availability: level >= GA_STAT_BRIEF

Definition at line 174 of file GA_Stat.h.

const ga_StatVolume& GA_Stat::getVolume ( int  idx) const
inline

Volume interface Availability: level >= GA_STAT_FULL

Definition at line 307 of file GA_Stat.h.

void GA_Stat::output ( UT_WorkBuffer buffer,
GA_STAT_LEVEL  level,
bool  pretty_print 
) const

Common output.

void GA_Stat::outputAttributes ( UT_WorkBuffer buffer,
bool  pretty_print 
) const

Output attribute information only. This appends to the work buffer.

void GA_Stat::outputGroups ( UT_WorkBuffer buffer,
bool  pretty_print 
) const

Output attribute information only. This appends to the work buffer.

void GA_Stat::outputVolumes ( UT_WorkBuffer buffer,
bool  pretty_print 
) const

Output volume information only. This appends to the work buffer.

void GA_Stat::setBounds ( const UT_BoundingBox b)
inline

Get bounding box Availability: level >= GA_STAT_FULL

Definition at line 314 of file GA_Stat.h.

void GA_Stat::setInfoOptions ( const UT_Options info,
const char *  bounds_name = "bounds" 
)

Set the info block options stored in the file If a float array option is found with the bounds_name, it will be used to initialize the bounding box of the stat.

The file stat should set these options if possible.

void GA_Stat::setIO ( const GA_IO *  io)
inline

Set/get the GA_IO which performed the stat

Definition at line 333 of file GA_Stat.h.

void GA_Stat::setPointCount ( GA_Size  sz)
inline

Get/Set the number of elements in the detail Availability: level >= GA_STAT_BRIEF

Definition at line 177 of file GA_Stat.h.

void GA_Stat::setPrimitiveCount ( GA_Size  sz)
inline

Get/Set the number of elements in the detail Availability: level >= GA_STAT_BRIEF

Definition at line 179 of file GA_Stat.h.

void GA_Stat::setPrimitiveCount ( const UT_StringHolder type_name,
GA_Size  count 
)
inline

Primitive interface Availability: level >= GA_STAT_FULL

Definition at line 271 of file GA_Stat.h.

void GA_Stat::setVertexCount ( GA_Size  sz)
inline

Get/Set the number of elements in the detail Availability: level >= GA_STAT_BRIEF

Definition at line 178 of file GA_Stat.h.


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