A component definition interface.
More...
List of all members.
Public Types |
enum | ComponentDefinitionType { Normal = 1,
Group = 2,
Image = 3
} |
| The type of component definition.
More...
|
Public Member Functions |
HRESULT | _GetInsertionPoint ([out, retval] double pPoint3d[3]) |
| [propget] The default insertion point.
|
Properties |
BSTR | Name [get] |
| [propget] Returns the name of the component definition.
|
BSTR | Description [get] |
| [propget] Returns the description of the component definition.
|
BSTR | Guid [get] |
| [propget] Returns the GUID of the component definition.
|
BOOL | IsInternal [get] |
| [propget] Is this definition internal?
|
BSTR | Path [get] |
| [propget] Returns the path to the file from which the component definition was loaded.
|
DATE | LoadTime [get] |
| [propget] Returns the time the component definition was loaded from a file (if it was loaded from a file).
|
ISkpNamedValues | Behaviors [get] |
| [propget] Returns the behaviors associated with the component definition.
|
ISkpOpenings | Openings [get] |
| [propget] Returns the openings cut by the component definition.
|
ISkpPoint3d | InsertionPoint [get] |
| [propget] The default insertion point.
|
ComponentDefinitionType | Type [get] |
| [propget] The type of definition.
|
Detailed Description
A component definition interface.
- Examples:
-
GetEntitesFromEntityProvider.cpp.
Member Enumeration Documentation
The type of component definition.
A Component definition is used as the base representation for three (3) kinds of objects in SketchUp:
- Components
- Groups
- Images This type enumeration, obtained via the ISkpComponentDefinition::Type property, identifies the type of definition one has.
Note: In general, and to protect oneself from potential changes in implementation, a client application should only deal with "Normal" component definitions, and treat Groups and Images as separate object types.
Member Function Documentation
HRESULT ISkpComponentDefinition::_GetInsertionPoint |
( |
[out, retval] double |
pPoint3d[3] |
) |
|
[propget] The default insertion point.
The calling application is expected to have allocated space for the return value.
- Return values:
-
| pVal | The default insertion point. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
Property Documentation
[propget] Returns the behaviors associated with the component definition.
A component definition's behaviors include the following properties:
-
Is2D
-
CutsOpening
-
SnapTo
-
Any
-
Horizontal
-
Vertical
-
Sloped
- Return values:
-
| pVal | The behaviors associated with the component definition. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpComponentDefinition::Description [get] |
[propget] Returns the description of the component definition.
- Return values:
-
| pVal | The component definition's description. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpComponentDefinition::Guid [get] |
[propget] Returns the GUID of the component definition.
- Return values:
-
| pVal | The component definition's GUID. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
ISkpPoint3d ISkpComponentDefinition::InsertionPoint [get] |
[propget] The default insertion point.
- Return values:
-
| pVal | The default insertion point. |
- Returns:
- S_OK : if successful
- E_POINTER : if any of the required arguments are NULL
- E_FAIL : internal errors
BOOL ISkpComponentDefinition::IsInternal [get] |
[propget] Is this definition internal?
When a component is loaded into SketchUp from an external library, it may come with a host of internal component instances/definitions that make up the overall definition. These are tagged as "internal" and by default not shown in the component browser. This property is accessed through the IsInternal property.
- Return values:
-
| pIsInternal | TRUE iff the component definition is considered internal. |
- Returns:
- S_OK : if successful
- E_POINTER : if any of the required arguments are NULL
- E_FAIL : internal errors
DATE ISkpComponentDefinition::LoadTime [get] |
[propget] Returns the time the component definition was loaded from a file (if it was loaded from a file).
If the component definition was not loaded from a file, the return value is undefined.
- See also:
- ISkpComponentDefinition::IsInternal
- Return values:
-
| pVal | The time the component definition was loaded from a file. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpComponentDefinition::Name [get] |
[propget] Returns the name of the component definition.
- Return values:
-
| pVal | The component definition's name. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
[propget] Returns the openings cut by the component definition.
- Return values:
-
| pVal | The openings cut by the component definition. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
BSTR ISkpComponentDefinition::Path [get] |
[propget] Returns the path to the file from which the component definition was loaded.
- Return values:
-
| pVal | The path to the file defining the component definition. If the component definition was not loaded from a file, the path is empty. |
- Returns:
- S_OK : if successful
E_POINTER : if any of the required arguments are NULL
E_FAIL : internal errors
[propget] The type of definition.
- Return values:
-
| pType | The Type of this component definition. |
- Returns:
- S_OK : if successful
- E_POINTER : if any of the required arguments are NULL
- E_FAIL : internal errors