SketchUp C API
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Related Functions
SUSectionPlaneRef Struct Reference

A sectionPlane entity reference. More...

#include <SketchUpAPI/model/section_plane.h>

Inherits SUDrawingElementRef.

Related Functions

(Note that these are not member functions.)

SUEntityRef SUSectionPlaneToEntity (SUSectionPlaneRef sectionPlane)
 Converts from an SUSectionPlaneRef to an SUEntityRef. This is essentially an upcast operation. More...
 
SUSectionPlaneRef SUSectionPlaneFromEntity (SUEntityRef entity)
 Converts from an SUEntityRef to an SUSectionPlaneRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUSectionPlaneRef. More...
 
SUDrawingElementRef SUSectionPlaneToDrawingElement (SUSectionPlaneRef sectionPlane)
 Converts from an SUSectionPlaneRef to an SUDrawingElementRef. This is essentially an upcast operation. More...
 
SUSectionPlaneRef SUSectionPlaneFromDrawingElement (SUDrawingElementRef drawing_elem)
 Converts from an SUDrawingElementRef to an SUSectionPlaneRef. This is essentially a downcast operation so the given element must be convertible to an SUSectionPlaneRef. More...
 
enum SUResult SUSectionPlaneCreate (SUSectionPlaneRef *sectionPlane)
 Creates an sectionPlane object. The sectionPlane object must be subsequently deallocated with SUSectionPlaneRelease() unless it is associated with a parent object. The plane is initialized as an xy plane and can be changed with the SUSectionPlaneSetPlane(). More...
 
enum SUResult SUSectionPlaneRelease (SUSectionPlaneRef *sectionPlane)
 Releases a sectionPlane object. The sectionPlane object must have been created with SUSectionPlaneCreate() and not subsequently associated with a parent object (e.g. SUEntitiesRef). More...
 
enum SUResult SUSectionPlaneSetPlane (SUSectionPlaneRef sectionPlane, const struct SUPlane3D *plane)
 Sets the plane of the section plane. More...
 
enum SUResult SUSectionPlaneGetPlane (SUSectionPlaneRef sectionPlane, struct SUPlane3D *plane)
 Retrieves the plane of the section plane. More...
 
enum SUResult SUSectionPlaneIsActive (SUSectionPlaneRef sectionPlane, bool *is_active)
 Retrieves a boolean indicating whether or not the section plane is active. More...
 
enum SUResult SUSectionPlaneGetName (SUSectionPlaneRef sectionPlane, SUStringRef *name)
 Retrieves the name of a section plane object. More...
 
enum SUResult SUSectionPlaneSetName (SUSectionPlaneRef sectionPlane, const char *name)
 Sets the name of a section plane object. More...
 
enum SUResult SUSectionPlaneGetSymbol (SUSectionPlaneRef sectionPlane, SUStringRef *symbol)
 Retrieves the symbol of a section plane object. The symbol is used in the Outliner and in the section display in the model. For example, you might have several sections on the same area of a building all named "South West Section" and use symbols to differenciate each section, "01", "02", "03". More...
 
enum SUResult SUSectionPlaneSetSymbol (SUSectionPlaneRef sectionPlane, const char *symbol)
 Sets the symbol of a section plane object. More...
 

Detailed Description

A sectionPlane entity reference.

Since
SketchUp 2016, API 4.0

Friends And Related Function Documentation

enum SUResult SUSectionPlaneCreate ( SUSectionPlaneRef sectionPlane)
related

Creates an sectionPlane object. The sectionPlane object must be subsequently deallocated with SUSectionPlaneRelease() unless it is associated with a parent object. The plane is initialized as an xy plane and can be changed with the SUSectionPlaneSetPlane().

Since
SketchUp 2016, API 4.0
Parameters
[in]sectionPlaneThe sectionPlane object.
Returns
SUSectionPlaneRef SUSectionPlaneFromDrawingElement ( SUDrawingElementRef  drawing_elem)
related

Converts from an SUDrawingElementRef to an SUSectionPlaneRef. This is essentially a downcast operation so the given element must be convertible to an SUSectionPlaneRef.

Since
SketchUp 2016, API 4.0
Parameters
[in]drawing_elemThe given element reference.
Returns
  • The converted SUSectionPlaneRef if the downcast operation succeeds
  • If not, the returned reference will be invalid.
SUSectionPlaneRef SUSectionPlaneFromEntity ( SUEntityRef  entity)
related

Converts from an SUEntityRef to an SUSectionPlaneRef. This is essentially a downcast operation so the given SUEntityRef must be convertible to an SUSectionPlaneRef.

Since
SketchUp 2016, API 4.0
Parameters
[in]entityThe entity object.
Returns
  • The converted SUSectionPlaneRef if the downcast operation succeeds
  • If the downcast operation fails, the returned reference will be invalid
enum SUResult SUSectionPlaneGetName ( SUSectionPlaneRef  sectionPlane,
SUStringRef name 
)
related

Retrieves the name of a section plane object.

Since
SketchUp 2018, API 6.0
Parameters
[in]sectionPlaneThe section plane object.
[out]nameThe name retrieved.
Returns
enum SUResult SUSectionPlaneGetPlane ( SUSectionPlaneRef  sectionPlane,
struct SUPlane3D plane 
)
related

Retrieves the plane of the section plane.

Parameters
[in]sectionPlaneThe sectionPlane object.
[out]planeThe 3d plane retrieved.
Returns
enum SUResult SUSectionPlaneGetSymbol ( SUSectionPlaneRef  sectionPlane,
SUStringRef symbol 
)
related

Retrieves the symbol of a section plane object. The symbol is used in the Outliner and in the section display in the model. For example, you might have several sections on the same area of a building all named "South West Section" and use symbols to differenciate each section, "01", "02", "03".

Since
SketchUp 2018, API 6.0
Parameters
[in]sectionPlaneThe section plane object.
[out]symbolThe symbol retrieved.
Returns
enum SUResult SUSectionPlaneIsActive ( SUSectionPlaneRef  sectionPlane,
bool *  is_active 
)
related

Retrieves a boolean indicating whether or not the section plane is active.

Parameters
[in]sectionPlaneThe sectionPlane object.
[out]is_activeReturns true if the section plane is active.
Returns
enum SUResult SUSectionPlaneRelease ( SUSectionPlaneRef sectionPlane)
related

Releases a sectionPlane object. The sectionPlane object must have been created with SUSectionPlaneCreate() and not subsequently associated with a parent object (e.g. SUEntitiesRef).

Since
SketchUp 2016, API 4.0
Parameters
[in]sectionPlaneThe sectionPlane object.
Returns
enum SUResult SUSectionPlaneSetName ( SUSectionPlaneRef  sectionPlane,
const char *  name 
)
related

Sets the name of a section plane object.

Since
SketchUp 2018, API 6.0
Parameters
[in]sectionPlaneThe section plane object.
[in]nameThe string to set as the section plane name. Assumed to be UTF-8 encoded. An example of a name would be "South West Section" for the section on the south west side of a building.
Returns
enum SUResult SUSectionPlaneSetPlane ( SUSectionPlaneRef  sectionPlane,
const struct SUPlane3D plane 
)
related

Sets the plane of the section plane.

Parameters
[in]sectionPlaneThe sectionPlane object.
[in]planeThe 3d plane to be set.
Returns
enum SUResult SUSectionPlaneSetSymbol ( SUSectionPlaneRef  sectionPlane,
const char *  symbol 
)
related

Sets the symbol of a section plane object.

Since
SketchUp 2018, API 6.0
Parameters
[in]sectionPlaneThe section plane object.
[in]symbolThe string to set as the section plane symbol. Assumed to be UTF-8 encoded. The maximum number of characters is 3.
Returns
SUDrawingElementRef SUSectionPlaneToDrawingElement ( SUSectionPlaneRef  sectionPlane)
related

Converts from an SUSectionPlaneRef to an SUDrawingElementRef. This is essentially an upcast operation.

Since
SketchUp 2016, API 4.0
Parameters
[in]sectionPlaneThe given sectionPlane reference.
Returns
  • The converted SUEntityRef if sectionPlane is a valid sectionPlane
  • If not, the returned reference will be invalid
SUEntityRef SUSectionPlaneToEntity ( SUSectionPlaneRef  sectionPlane)
related

Converts from an SUSectionPlaneRef to an SUEntityRef. This is essentially an upcast operation.

Since
SketchUp 2016, API 4.0
Parameters
[in]sectionPlaneThe sectionPlane object.
Returns
  • The converted SUEntityRef if sectionPlane is a valid object
  • If not, the returned reference will be invalid

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