References a line style. More...

#include <SketchUpAPI/model/line_style.h>

Related Functions
(Note that these are not member functions.)
SUEntityRef	SULineStyleToEntity (SULineStyleRef line_style)
	Converts from a SULineStyleRef to an SUEntityRef. This is essentially an upcast operation. More...

SULineStyleRef	SULineStyleFromEntity (SUEntityRef entity_ref)
	Converts from an SUEntityRef to a SULineStyleRef. This is essentially a downcast operation so the given entity must be convertible to a SULineStyleRef. More...

enum SUResult	SULineStyleGetName (SULineStyleRef line_style, SUStringRef *name)
	Retrieves the name of a line style object. More...

Related Functions inherited from SUEntityRef
enum SURefType	SUEntityGetType (SUEntityRef entity)
	Returns the concrete type of the given entity. More...

enum SUResult	SUEntityGetID (SUEntityRef entity, int32_t *entity_id)
	Retrieves the id of the entity. More...

enum SUResult	SUEntityGetPersistentID (SUEntityRef entity, int64_t *entity_pid)
	Retrieves the persistent id of the entity. More...

enum SUResult	SUEntityGetNumAttributeDictionaries (SUEntityRef entity, size_t *count)
	Retrieves the number of attribute dictionaries of an entity. More...

enum SUResult	SUEntityGetAttributeDictionaries (SUEntityRef entity, size_t len, SUAttributeDictionaryRef dictionaries[], size_t *count)
	Retrieves the attribute dictionaries of an entity. More...

enum SUResult	SUEntityAddAttributeDictionary (SUEntityRef entity, SUAttributeDictionaryRef dictionary)
	Adds the attribute dictionary to an entity. The given dictionary object must not belong to another entity. In other words, each dictionary should be added to one entity only. More...

enum SUResult	SUEntityGetAttributeDictionary (SUEntityRef entity, const char name, SUAttributeDictionaryRef dictionary)
	Retrieves the attribute dictionary of an entity that has the given name. More...

enum SUResult	SUEntityGetModel (SUEntityRef entity, SUModelRef *model)
	Retrieves the model object associated with the entity. More...

enum SUResult	SUEntityGetParentEntities (SUEntityRef entity, SUEntitiesRef *entities)
	Retrieves the entities object which contains the entity. More...

Detailed Description

References a line style.

Friends And Related Function Documentation

SULineStyleRef SULineStyleFromEntity ( SUEntityRef entity_ref )

Since: SketchUp 2020.1, API 8.1

Parameters

[in] entity_ref The given entity reference.

Returns

The converted SULineStyleRef if the downcast operation succeeds
If not, the returned reference will be invalid

enum SUResult SULineStyleGetName	(	SULineStyleRef	line_style,
		SUStringRef *	name
	)

Since: SketchUp 2019, API 7.0

Parameters

[in]	line_style	The line style object.
[out]	name	The name retrieved.

Returns

SU_ERROR_NONE on success
SU_ERROR_INVALID_INPUT if line_style is not a valid object
SU_ERROR_NULL_POINTER_OUTPUT if name is NULL
SU_ERROR_INVALID_OUTPUT if name does not point to a valid SUStringRef object

SUEntityRef SULineStyleToEntity ( SULineStyleRef line_style )

Since: SketchUp 2020.1, API 8.1

Parameters

[in] line_style The given line style reference.

Returns

The converted SUEntityRef if line_style is a valid line style
If not, the returned reference will be invalid

The documentation for this struct was generated from the following files:

SketchUpAPI/model/defs.h
SketchUpAPI/model/line_style.h

Related Functions

Detailed Description

Friends And Related Function Documentation