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

Public Member Functions | Properties

ISkpComponentInstance Interface Reference

A component instance interface. More...

Inheritance diagram for ISkpComponentInstance:
SkpComponentInstance

List of all members.

Public Member Functions

HRESULT GetObjectsAttachedTo ([out, retval] ISkpEntities **pVal)
 Get the Faces and ComponentInstances to which this ComponentInstance is attached.
HRESULT GetAttachedComponentInstances ([out, retval]ISkpComponentInstances **pVal)
 Get the ComponentInstances that are attached to this component instance.
HRESULT SaveAs ([in] BSTR fileName)
 Save the ComponentInstance to the file of the given name.

Properties

ISkpComponentDefinition ComponentDefinition [get]
 [propget] Returns the component definition from whence this instance came.
ISkpTransform Transform [get]
 [propget] Returns the transform that maps the corresponding component definition to this instance.
BSTR Name [get]
 Allows access to the name of the component instance.

Detailed Description

A component instance interface.


Member Function Documentation

HRESULT ISkpComponentInstance::GetAttachedComponentInstances ( [out, retval] ISkpComponentInstances **  pVal  ) 

Get the ComponentInstances that are attached to this component instance.

See also:
ISkpFace::GetAttachedComponentInstances
Return values:
pVal The ComponentInstances that are attached to this component instance.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpComponentInstance::GetObjectsAttachedTo ( [out, retval] ISkpEntities **  pVal  ) 

Get the Faces and ComponentInstances to which this ComponentInstance is attached.

Return values:
pVal The Faces and ComponentInstances to which this ComponentInstance is attached.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
HRESULT ISkpComponentInstance::SaveAs ( [in] BSTR  fileName  ) 

Save the ComponentInstance to the file of the given name.

If the file name does not end with ".skp", this will be added.

Parameters:
fileName The file to which this instance should be saved.
Returns:
S_OK : if successful
E_FAIL : internal errors

Property Documentation

ISkpComponentDefinition ISkpComponentInstance::ComponentDefinition [get]

[propget] Returns the component definition from whence this instance came.

Return values:
pVal The component definition that defines this instance.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpComponentInstance::Name [get]

Allows access to the name of the component instance.

Return values:
pName The name of the component instance.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpTransform ISkpComponentInstance::Transform [get]

[propget] Returns the transform that maps the corresponding component definition to this instance.

Return values:
pVal The instance's transform from its definition.
Returns:
S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors

©2010 Google - Google Home - About Google