---
name: "SoLinePatternElement"
section: "3"
platform: "linux"
package: "coin"
version: "1:4.0.10-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/SoLinePatternElement"
---

# SoLinePatternElement(3)

The SoLinePatternElement class defines the line stipple pattern.

## NAME

SoLinePatternElement - The **SoLinePatternElement** class defines the line stipple pattern.

## SYNOPSIS

\#include \<Inventor/elements/SoLinePatternElement.h\>

Inherits **SoInt32Element**.

Inherited by **SoGLLinePatternElement**.

### Public Types

enum **Patterns** { **CONTINUOUS** = 0xFFFF }\

### Public Member Functions

virtual void **init** (**SoState** \*state)\

Public Member Functions inherited from **SoInt32Element** virtual SbBool **matches** (const **SoElement** \*element) const\
 virtual **SoElement** \* **copyMatchInfo** (void) const\
 virtual void **print** (FILE \*file) const\
 virtual void **setElt** (int32\_t value)\

Public Member Functions inherited from **SoElement** const **SoType** **getTypeId** (void) const\
 int **getStackIndex** (void) const\
 virtual void **push** (**SoState** \*state)\
 virtual void **pop** (**SoState** \*state, const **SoElement** \*prevTopElement)\
 void **setDepth** (const int **depth**)\
 int **getDepth** (void) const\
 virtual **~SoElement** ()\

### Static Public Member Functions

static **SoType** **getClassTypeId** (void)\
 static int **getClassStackIndex** (void)\
 static void \* **createInstance** (void)\
 static void **initClass** (void)\
 static void **set** (**SoState** \*const state, **SoNode** \*const node, const int32\_t pattern, const int32\_t factor=1)\
 static void **set** (**SoState** \*const state, const int32\_t pattern, const int32\_t factor=1)\
 static int32\_t **get** (**SoState** \*const state)\
 static int32\_t **getDefault** ()\
 static int32\_t **getScaleFactor** (**SoState** \*const state)\
 static int32\_t **getDefaultScaleFactor** ()\

Static Public Member Functions inherited from **SoInt32Element** static **SoType** **getClassTypeId** (void)\
 static int **getClassStackIndex** (void)\
 static void **initClass** (void)\
 static void **set** (const int index, **SoState** \*const state, **SoNode** \*const node, const int32\_t value)\
 static void **set** (const int index, **SoState** \*const state, const int32\_t value)\
 static int32\_t **get** (const int index, **SoState** \*const state)\

Static Public Member Functions inherited from **SoElement** static void **initClass** (void)\
 static **SoType** **getClassTypeId** (void)\
 static int **getClassStackIndex** (void)\
 static void **initElements** (void)\
 static int **getNumStackIndices** (void)\
 static **SoType** **getIdFromStackIndex** (const int **stackIndex**)\

### Protected Member Functions

virtual **~SoLinePatternElement** ()\

Protected Member Functions inherited from **SoInt32Element** virtual **~SoInt32Element** ()\

Protected Member Functions inherited from **SoElement** **SoElement** (void)\
 void **capture** (**SoState** \*const state) const\
 virtual void **captureThis** (**SoState** \*state) const\
 void **setTypeId** (const **SoType** **typeId**)\
 void **setStackIndex** (const int index)\
 **SoElement** \* **getNextInStack** (void) const\
 **SoElement** \* **getNextFree** (void) const\

### Additional Inherited Members

Static Protected Member Functions inherited from **SoElement** static **SoElement** \* **getElement** (**SoState** \*const state, const int **stackIndex**)\
 static const **SoElement** \* **getConstElement** (**SoState** \*const state, const int **stackIndex**)\
 static int **createStackIndex** (const **SoType** id)\

Protected Attributes inherited from **SoInt32Element** int32\_t **data**\

Protected Attributes inherited from **SoElement** **SoType** **typeId**\
 int **stackIndex**\
 int **depth**\

Static Protected Attributes inherited from **SoElement** static int **classStackIndex**\
 static **SoTypeList** \* **stackToType**\

## Detailed Description

The **SoLinePatternElement** class defines the line stipple pattern.

Line stippling is used to mask out fragments of a line.

## Constructor & Destructor Documentation

### SoLinePatternElement::~SoLinePatternElement (void ) \[protected\], \[virtual\]

Destructor.

## Member Function Documentation

### SoType SoLinePatternElement::getClassTypeId (void ) \[static\]

This static method returns the **SoType** object associated with objects of this class.

### int SoLinePatternElement::getClassStackIndex (void ) \[static\]

This static method returns the state stack index for the class.

### void \* SoLinePatternElement::createInstance (void ) \[static\]

*This API member is considered internal to the library, as it is not likely to be of interest to the application programmer.*\

 Creates a new instance of the class type corresponding to the **SoType** object.

### void SoLinePatternElement::initClass (void ) \[static\]

Initialize relevant common data for all instances, like the type system.

### void SoLinePatternElement::init (SoState \* state) \[virtual\]

Initializes element in state to default value.

Reimplemented from **SoInt32Element**.

Reimplemented in **SoGLLinePatternElement**.

### void SoLinePatternElement::set (SoState \*const state, SoNode \*const node, const int32\_t pattern, const int32\_t factor = 1) \[static\]

Sets the given pattern in the state.

### void SoLinePatternElement::set (SoState \*const state, const int32\_t pattern, const int32\_t factor = 1) \[static\]

Sets the given pattern in the state.

### int32\_t SoLinePatternElement::get (SoState \*const state) \[static\]

Returns line stipple pattern from state.

### int32\_t SoLinePatternElement::getDefault () \[static\]

Returns default line stipple pattern.

### int32\_t SoLinePatternElement::getScaleFactor (SoState \*const state) \[static\]

Returns line stipple pattern scale factor from state.

### int32\_t SoLinePatternElement::getDefaultScaleFactor () \[static\]

Returns default line stipple pattern scale factor.

## Author

Generated automatically by Doxygen for Coin from the source code.