Go to Google Code Home
Google SketchUp SkpReader C++ API Documentation (Labs)

Public Types | Public Member Functions | Properties

ISkpEntityProviderStatistics Interface Reference

Data about an Entity Provider. More...

List of all members.

Public Types

enum  StatisticsType {
  statEdge = 0, statFace = 1, statComponentInstance = 2, statConstructionLine = 3,
  statConstructionPoint = 4, statGroup = 5, statImage = 6, statCurve = 7,
  statSection = 8, statDimension = 9, statText = 10, statComponentDefinition = 11
}

Public Member Functions

HRESULT GetTypeName ([in] StatisticsType typeIndex,[out, retval]BSTR *pTypeName)
 Returns the name of the type found at the given index.
HRESULT GetCount ([in]StatisticsType typeIndex,[in]BOOL bIncludeInstances,[out, retval]long *pCount)
 Returns the number of objects of the type indicated by the type parameter.

Properties

long NumberOfTypes [get]
 Returns the number of types available.

Detailed Description

Data about an Entity Provider.

See also:
ISkpEntityProvider

Member Enumeration Documentation

An enumeration of types supported by the statistics class.

Enumerator:
statEdge 

An edge type.

statFace 

A face type.

statComponentInstance 

A component instance type.

statConstructionLine 

A construction line type.

statConstructionPoint 

A construction point type.

statGroup 

A group type.

statImage 

An image type.

statCurve 

A curve type.

statSection 

A section type.

statDimension 

A dimension type.

statText 

A text type.

statComponentDefinition 

A component definition type.


Member Function Documentation

HRESULT ISkpEntityProviderStatistics::GetCount ( [in] StatisticsType  typeIndex,
[in] BOOL  bIncludeInstances,
[out, retval] long *  pCount 
)

Returns the number of objects of the type indicated by the type parameter.

Parameters:
typeIndex The entry type.
bIncludeInstances If true, instances will be included in the statistic calculations.
Return values:
pCount The number of objects of the type identified by the typeIndex.
Returns:
  • S_OK : if successful
  • E_POINTER : if pTypeName == NULL
  • E_INVALIDARG : if index < 0 or indx >= NumberOfTypes.
  • E_UNEXPECTED : indicates unexpected internal errors
HRESULT ISkpEntityProviderStatistics::GetTypeName ( [in] StatisticsType  typeIndex,
[out, retval] BSTR *  pTypeName 
)

Returns the name of the type found at the given index.

Parameters:
typeIndex The entry index.
Return values:
pTypeName Space for the type name at the index'th entry.
Returns:
  • S_OK : if successful
  • E_POINTER : if pTypeName == NULL
  • E_INVALIDARG : if index < 0 or indx >= NumberOfTypes.
  • E_UNEXPECTED : indicates unexpected internal errors

Property Documentation

long ISkpEntityProviderStatistics::NumberOfTypes [get]

Returns the number of types available.

Return values:
pNumTypes The number of types available.
Returns:
  • S_OK : if successful
  • E_POINTER : if pNumTypes == NULL
  • E_UNEXPECTED : indicates unexpected internal errors

©2010 Google - Google Home - About Google