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

Public Member Functions | Properties

ISkpEntityProvider Interface Reference

An interface supported by those objects that serve as collections of entities. More...

Inheritance diagram for ISkpEntityProvider:
SkpComponentDefinition SkpDocument SkpGroup SkpSelectionSet

List of all members.

Public Member Functions

HRESULT HasSectionCuts ([out, retval]BOOL *pVal)
 Determine whether there are any section cuts found within this provider.
HRESULT GetStatistics ([out, retval] ISkpEntityProviderStatistics **ppStats)
 Get statistics about this provider.

Properties

ISkpEdges Edges [get]
 [propget] Get the Edges contained within this object.
ISkpEdgeUses EdgeUses [get]
 [propget] Get the EdgeUses contained within this object.
ISkpFaces Faces [get]
 [propget] Get the Faces contained within this object.
ISkpVertices Vertices [get]
 [propget] Get the Vertices contained within this object.
ISkpPolyline3ds Polyline3ds [get]
 [propget] Get the Polyline3ds contained within this object.
ISkpLoops Loops [get]
 [propget] Get the Loops contained within this object.
ISkpImages Images [get]
 [propget] Get the Images contained within this object.
ISkpTexts Texts [get]
 [propget] Get the Texts contained within this object.
ISkpGroups Groups [get]
 [propget] Get the Groups contained within this object.
ISkpConstructionLines ConstructionLines [get]
 [propget] Get the ConstructionLines contained within this object.
ISkpConstructionPoints ConstructionPoints [get]
 [propget] Get the ConstructionPoints contained within this object.
ISkpDimensions Dimensions [get]
 [propget] Get the Dimensions contained within this object.
ISkpComponentInstances ComponentInstances [get]
 [propget] Get the ComponentInstances contained within this object.
ISkpEntities Entities [get]
 [propget] Get the Entities contained within this object.
ISkpSectionPlanes SectionPlanes [get]
 [propget] Get the SectionPlanes contained within this object.

Detailed Description

An interface supported by those objects that serve as collections of entities.


Member Function Documentation

HRESULT ISkpEntityProvider::GetStatistics ( [out, retval] ISkpEntityProviderStatistics **  ppStats  ) 

Get statistics about this provider.

Return values:
ppStats The statistics
Returns:
  • S_OK : if successful
  • E_POINTER : if ppStats == NULL
HRESULT ISkpEntityProvider::HasSectionCuts ( [out, retval] BOOL *  pVal  ) 

Determine whether there are any section cuts found within this provider.

Return values:
pVal True iff there is a section cut within this provider.
Returns:
  • S_OK : if successful
  • E_POINTER : if pVal == NULL

Property Documentation

ISkpComponentInstances ISkpEntityProvider::ComponentInstances [get]

[propget] Get the ComponentInstances contained within this object.

Return values:
pComponentInstances A Collection of ISkpComponentInstance objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pComponentInstances == NULL
ISkpConstructionLines ISkpEntityProvider::ConstructionLines [get]

[propget] Get the ConstructionLines contained within this object.

Return values:
pConstructionLines A Collection of ISkpConstructionLine objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pConstructionLines == NULL
ISkpConstructionPoints ISkpEntityProvider::ConstructionPoints [get]

[propget] Get the ConstructionPoints contained within this object.

Return values:
pConstructionPoints A Collection of ISkpConstructionPoint objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pConstructionPoints == NULL
ISkpDimensions ISkpEntityProvider::Dimensions [get]

[propget] Get the Dimensions contained within this object.

Return values:
pDimensions A Collection of ISkpDimension objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pDimensions == NULL
ISkpEdges ISkpEntityProvider::Edges [get]

[propget] Get the Edges contained within this object.

Return values:
pEdges A Collection of ISkpEdge objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pEdges == NULL
ISkpEdgeUses ISkpEntityProvider::EdgeUses [get]

[propget] Get the EdgeUses contained within this object.

Return values:
pEdgeUses A Collection of ISkpEdgeUse objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pEdgeUses == NULL
ISkpEntities ISkpEntityProvider::Entities [get]

[propget] Get the Entities contained within this object.

Return values:
pEntitys A Collection of ISkpEntity objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pEntities == NULL
ISkpFaces ISkpEntityProvider::Faces [get]

[propget] Get the Faces contained within this object.

Return values:
pFaces A Collection of ISkpFace objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pFaces == NULL
ISkpGroups ISkpEntityProvider::Groups [get]

[propget] Get the Groups contained within this object.

Return values:
pGroups A Collection of ISkpGroup objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pGroups == NULL
ISkpImages ISkpEntityProvider::Images [get]

[propget] Get the Images contained within this object.

Return values:
pImages A Collection of ISkpImage objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pImages == NULL
ISkpLoops ISkpEntityProvider::Loops [get]

[propget] Get the Loops contained within this object.

Return values:
pLoops A Collection of ISkpLoop objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pLoops == NULL
ISkpPolyline3ds ISkpEntityProvider::Polyline3ds [get]

[propget] Get the Polyline3ds contained within this object.

Return values:
pPolylines A Collection of ISkpPolyline3d objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pPolylines == NULL
ISkpSectionPlanes ISkpEntityProvider::SectionPlanes [get]

[propget] Get the SectionPlanes contained within this object.

Return values:
pEntitys A Collection of ISkpSectionPlane objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pEntities == NULL
ISkpTexts ISkpEntityProvider::Texts [get]

[propget] Get the Texts contained within this object.

Return values:
pTexts A Collection of ISkpText objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pTexts == NULL
ISkpVertices ISkpEntityProvider::Vertices [get]

[propget] Get the Vertices contained within this object.

Return values:
pVertices A Collection of ISkpVertex objects. This will never be NULL.
Returns:
S_OK : if successful
E_POINTER : if pVertices == NULL

©2010 Google - Google Home - About Google