SketchUp SDK
|
#include <slapi/geometry.h>
#include <slapi/slapi.h>
#include <slapi/unicodestring.h>
#include <slapi/model/curve.h>
#include <slapi/model/defs.h>
Go to the source code of this file.
Data Structures | |
struct | SUComponentBehavior |
Describes how the component behaves in the SketchUp rendering scene. More... | |
Functions | |
SU_EXPORT SUEntityRef | SUComponentDefinitionToEntity (SUComponentDefinitionRef comp_def) |
Converts from an SUComponentDefinitionRef to an SUEntityRef. This is essentially an upcast operation. More... | |
SU_EXPORT SUComponentDefinitionRef | SUComponentDefinitionFromEntity (SUEntityRef entity) |
Converts from an SUEntityRef to an SUComponentDefinitionRef. This is essentially a downcast operation so the given entity must be convertible to an SUComponentDefinitionRef. More... | |
SU_EXPORT SUDrawingElementRef | SUComponentDefinitionToDrawingElement (SUComponentDefinitionRef comp_def) |
Converts from an SUComponentDefinitionRef to an SUDrawingElementRef. This is essentially an upcast operation. More... | |
SU_EXPORT SUComponentDefinitionRef | SUComponentDefinitionFromDrawingElement (SUDrawingElementRef drawing_elem) |
Converts from an SUDrawingElementRef to an SUComponentDefinitionRef. This is essentially a downcast operation so the given element must be convertible to an SUComponentDefinitionRef. More... | |
SU_RESULT | SUComponentDefinitionCreate (SUComponentDefinitionRef *comp_def) |
Creates a new component definition. More... | |
SU_RESULT | SUComponentDefinitionRelease (SUComponentDefinitionRef *comp_def) |
Releases a component definition object and its associated resources. The object must not be associated with a parent component or model. More... | |
SU_RESULT | SUComponentDefinitionGetName (SUComponentDefinitionRef comp_def, SUStringRef *name) |
Retrieves the name of a component definition. More... | |
SU_RESULT | SUComponentDefinitionSetName (SUComponentDefinitionRef comp_def, const char *name) |
Sets the name of a component definition. More... | |
SU_RESULT | SUComponentDefinitionGetEntities (SUComponentDefinitionRef comp_def, SUEntitiesRef *entities) |
Retrieves the entities of the component definition. More... | |
SU_RESULT | SUComponentDefinitionGetDescription (SUComponentDefinitionRef comp_def, SUStringRef *desc) |
Retrieves the description of the component definition. More... | |
SU_RESULT | SUComponentDefinitionSetDescription (SUComponentDefinitionRef comp_def, const char *desc) |
Sets the description of the component definition. More... | |
SU_RESULT | SUComponentDefinitionCreateInstance (SUComponentDefinitionRef comp_def, SUComponentInstanceRef *instance) |
Create an instance of a component definition. More... | |
SU_RESULT | SUComponentDefinitionGetBehavior (SUComponentDefinitionRef comp_def, struct SUComponentBehavior *behavior) |
Retrieves the behavior of a component definition. More... | |
SU_RESULT | SUComponentDefinitionSetBehavior (SUComponentDefinitionRef comp_def, const struct SUComponentBehavior *behavior) |
Sets the component behavior of a component definition. More... | |
SU_RESULT SUComponentDefinitionCreate | ( | SUComponentDefinitionRef * | comp_def | ) |
Creates a new component definition.
The created definition must be released with SUComponentDefinitionRelease, or attached to either a parent component or parent model. A definition that has been attached to a parent component or parent model must not be released.
[out] | comp_def | The component object created. |
SU_RESULT SUComponentDefinitionCreateInstance | ( | SUComponentDefinitionRef | comp_def, |
SUComponentInstanceRef * | instance | ||
) |
Create an instance of a component definition.
[in] | comp_def | The component definition object. |
[out] | instance | The instance created. return
|
SU_EXPORT SUComponentDefinitionRef SUComponentDefinitionFromDrawingElement | ( | SUDrawingElementRef | drawing_elem | ) |
Converts from an SUDrawingElementRef to an SUComponentDefinitionRef. This is essentially a downcast operation so the given element must be convertible to an SUComponentDefinitionRef.
[in] | drawing_elem | The given element reference. |
SU_EXPORT SUComponentDefinitionRef SUComponentDefinitionFromEntity | ( | SUEntityRef | entity | ) |
Converts from an SUEntityRef to an SUComponentDefinitionRef. This is essentially a downcast operation so the given entity must be convertible to an SUComponentDefinitionRef.
[in] | entity | The given entity reference. |
SU_RESULT SUComponentDefinitionGetBehavior | ( | SUComponentDefinitionRef | comp_def, |
struct SUComponentBehavior * | behavior | ||
) |
Retrieves the behavior of a component definition.
[in] | comp_def | The component definition object. |
[out] | behavior | The component behavior retrieved. |
SU_RESULT SUComponentDefinitionGetDescription | ( | SUComponentDefinitionRef | comp_def, |
SUStringRef * | desc | ||
) |
Retrieves the description of the component definition.
[in] | comp_def | The component definition object. |
[out] | desc | The description retrieved. |
SU_RESULT SUComponentDefinitionGetEntities | ( | SUComponentDefinitionRef | comp_def, |
SUEntitiesRef * | entities | ||
) |
Retrieves the entities of the component definition.
[in] | comp_def | The component definition object. |
[out] | entities | The entities retrieved. |
SU_RESULT SUComponentDefinitionGetName | ( | SUComponentDefinitionRef | comp_def, |
SUStringRef * | name | ||
) |
Retrieves the name of a component definition.
[in] | comp_def | The component definition object. |
[out] | name | The name retrieved. |
SU_RESULT SUComponentDefinitionRelease | ( | SUComponentDefinitionRef * | comp_def | ) |
Releases a component definition object and its associated resources. The object must not be associated with a parent component or model.
[in] | comp_def | The component definition object. |
SU_RESULT SUComponentDefinitionSetBehavior | ( | SUComponentDefinitionRef | comp_def, |
const struct SUComponentBehavior * | behavior | ||
) |
Sets the component behavior of a component definition.
[in] | comp_def | The component definition object. |
[in] | behavior | The behavior to set. |
SU_RESULT SUComponentDefinitionSetDescription | ( | SUComponentDefinitionRef | comp_def, |
const char * | desc | ||
) |
Sets the description of the component definition.
[in] | comp_def | The component definition object. |
[in] | desc | The description to be set. Assumed to be UTF-8 encoded. |
SU_RESULT SUComponentDefinitionSetName | ( | SUComponentDefinitionRef | comp_def, |
const char * | name | ||
) |
Sets the name of a component definition.
[in] | comp_def | The component definition object. |
[in] | name | The name of the component definition. Assumed to be UTF-8 encoded. |
SU_EXPORT SUDrawingElementRef SUComponentDefinitionToDrawingElement | ( | SUComponentDefinitionRef | comp_def | ) |
Converts from an SUComponentDefinitionRef to an SUDrawingElementRef. This is essentially an upcast operation.
[in] | comp_def | The given component definition reference. |
SU_EXPORT SUEntityRef SUComponentDefinitionToEntity | ( | SUComponentDefinitionRef | comp_def | ) |
Converts from an SUComponentDefinitionRef to an SUEntityRef. This is essentially an upcast operation.
[in] | comp_def | The given component definition reference. |