VTK

https://vtk.org/doc/nightly/html/
Admin
The Visualization Toolkit (VTK) is an open-source software system for 3D computer graphics, image...
Tokens:36,522,823
Snippets:277,300
Trust Score:9.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### SetUp()

Source: https://vtk.org/doc/nightly/html/classvtkProjectedTexture.html

Sets or gets the up vector of the projector.

```APIDOC
## SetUp()

### Description
Sets or gets the up vector of the projector.

### Method
GET/SET

### Endpoint
/vtkProjectedTexture/SetUp

### Parameters
#### Request Body (for SET)
- **up_vector** (double[3]) - Required - The up vector of the projector.

### Response
#### Success Response (200)
- **return_value** (void) - Indicates success for SET operations. For GET, returns the up vector.
```

--------------------------------

### Initialization and Setup

Source: https://vtk.org/doc/nightly/html/vtkOpenGLContextDevice3D_8h_source.html

Methods for initializing the device and setting up rendering parameters.

```APIDOC
## New

### Description
Creates a new instance of vtkOpenGLContextDevice3D.

### Method
static vtkOpenGLContextDevice3D * New()

### Returns
A pointer to the newly created vtkOpenGLContextDevice3D object.
```

```APIDOC
## Initialize

### Description
Initializes the device with the given renderer and 2D context device.

### Method
void Initialize(vtkRenderer *, vtkOpenGLContextDevice2D *)

### Parameters
- **renderer** (vtkRenderer *) - The renderer to use.
- **context2D** (vtkOpenGLContextDevice2D *) - The 2D context device.
```

```APIDOC
## Begin

### Description
Begins the drawing process, setting up the view with the provided viewport.

### Method
virtual void Begin(vtkViewport *viewport)

### Parameters
- **viewport** (vtkViewport *) - The viewport to use for rendering.
```

--------------------------------

### Get Streamline Start Position

Source: https://vtk.org/doc/nightly/html/vtkEvenlySpacedStreamlines2D_8h_source.html

Get the starting position for streamlines. This is a 3-component double array.

```c++
double* GetStartPosition();
```

--------------------------------

### SetupPalette

Source: https://vtk.org/doc/nightly/html/classvtkCocoaRenderWindow.html

Initializes OpenGL for the window, likely setting up the color palette.

```APIDOC
## SetupPalette()

### Description
Initialize OpenGL for this window.

### Method
void vtkCocoaRenderWindow::SetupPalette(void * _hDC_)
```

--------------------------------

### Get Starting Physical Event Pose

Source: https://vtk.org/doc/nightly/html/classvtkOpenXRRenderWindowInteractor.html

Get the starting physical/room coordinate pose (position and orientation) of events.

```APIDOC
## GetStartingPhysicalEventPose

### Description
With VR, we know the physical/room coordinate positions and orientations of events.

### Method
`virtual void GetStartingPhysicalEventPose(vtkMatrix4x4 *poseMatrix, int pointerIndex)`
```

--------------------------------

### Setup Output

Source: https://vtk.org/doc/nightly/html/vtkEvenlySpacedStreamlines2D_8h_source.html

Helper method to set up the output information.

```c++
int SetupOutput(vtkInformation* inInfo, vtkInformation* outInfo);
```

--------------------------------

### Get Major Start Position

Source: https://vtk.org/doc/nightly/html/vtkAxisActor_8h_source.html

Gets the starting position for minor and major tick points, and the delta values that determine the tick marks.

```cpp
double GetMajorStart(int axis)

```

--------------------------------

### SetupEmptyOutput

Source: https://vtk.org/doc/nightly/html/classvtkXMLPTableReader.html

Initializes the current output, preparing it for data.

```APIDOC
## SetupEmptyOutput

### Description
Initialize current output.

### Method
void SetupEmptyOutput() override
```

--------------------------------

### Getting Start Location

Source: https://vtk.org/doc/nightly/html/classvtkHyperStreamline.html

Methods to retrieve the starting location of the hyperstreamline.

```APIDOC
## GetStartLocation

### Description
Get the starting location of the hyperstreamline in the cell coordinate system.

### Method
vtkIdType GetStartLocation (int &subId, double pcoords[3])

### Parameters
* **subId** (int&) - Output parameter for the sub-identifier of the cell.
* **pcoords** (double[3]) - Output parameter for the normalized coordinates within the cell.

### Returns
vtkIdType - The ID of the cell where the hyperstreamline starts.
```

--------------------------------

### Start Rendering

Source: https://vtk.org/doc/nightly/html/vtkRenderWindow_8h_source.html

Virtual function to be called before rendering begins. Typically used for setup.

```cpp
virtual void Start() {}
```

--------------------------------

### Get Subaction Paths

Source: https://vtk.org/doc/nightly/html/vtkOpenXRManager_8h_source.html

Gets the subaction paths for the current OpenXR setup.

```APIDOC
## GetSubactionPaths

### Description
Retrieves the array of subaction paths, which are used for differentiating input from different controllers or parts of a device.

### Method
const std::array<XrPath, 2>& GetSubactionPaths()

### Returns
A constant reference to an array containing two XrPath handles for subactions.
```

--------------------------------

### SetupActions

Source: https://vtk.org/doc/nightly/html/classvtkOpenVRInteractorStyle.html

Sets up default actions with an action path and a corresponding command. Implements vtkVRInteractorStyle.

```APIDOC
## SetupActions()

void vtkOpenVRInteractorStyle::SetupActions(vtkRenderWindowInteractor * _iren_)

override virtual

Setup default actions defined with an action path and a corresponding command. Implements vtkVRInteractorStyle.
```

--------------------------------

### Get Start Position

Source: https://vtk.org/doc/nightly/html/vtkHyperStreamline_8h_source.html

Retrieves the starting position of the hyperstreamline in global coordinates.

```APIDOC
## GetStartPosition

### Description
Get the start position of the hyperstreamline in global x-y-z coordinates.

### Method
`double * GetStartPosition()`

### Returns
A pointer to a double array containing the x, y, and z coordinates of the start position.
```

--------------------------------

### SetUp

Source: https://vtk.org/doc/nightly/html/functions_func_s.html

Performs setup operations for vtkKdNode and vtkProjectedTexture.

```APIDOC
## SetUp

### Description
Performs setup operations for vtkKdNode and vtkProjectedTexture.

### Method
Not specified (likely a setup or initialization method).

### Endpoint
Not applicable (SDK/library function).

### Parameters
None explicitly defined in the source.

### Response
None explicitly defined in the source.
```

--------------------------------

### Starting Position

Source: https://vtk.org/doc/nightly/html/classvtkPStreamTracer.html

Methods for setting and getting the starting point (seed) of a streamline.

```APIDOC
## SetStartPosition (double, double, double)

### Description
Specify the starting point (seed) of a streamline in the global coordinate system.

### Method
`virtual void SetStartPosition(double, double, double)`

### Endpoint
N/A (C++ method)

### Parameters
- **x** (double) - The x-coordinate.
- **y** (double) - The y-coordinate.
- **z** (double) - The z-coordinate.

## SetStartPosition (double[3])

### Description
Specify the starting point (seed) of a streamline in the global coordinate system.

### Method
`virtual void SetStartPosition(double[3])`

### Endpoint
N/A (C++ method)

### Parameters
- **pos** (double[3]) - An array containing the x, y, and z coordinates.

## GetStartPosition (double *)

### Description
Specify the starting point (seed) of a streamline in the global coordinate system.

### Method
`virtual double * GetStartPosition()`

### Endpoint
N/A (C++ method)

### Returns
double * - A pointer to the starting position array.

## GetStartPosition (double &, double &, double &)

### Description
Specify the starting point (seed) of a streamline in the global coordinate system.

### Method
`virtual void GetStartPosition(double &, double &, double &)`

### Endpoint
N/A (C++ method)

### Parameters
- **x** (double &) - Reference to the x-coordinate.
- **y** (double &) - Reference to the y-coordinate.
- **z** (double &) - Reference to the z-coordinate.

## GetStartPosition (double[3])

### Description
Specify the starting point (seed) of a streamline in the global coordinate system.

### Method
`virtual void GetStartPosition(double[3])`

### Endpoint
N/A (C++ method)

### Parameters
- **pos** (double[3]) - An array to store the starting position.
```

--------------------------------

### Information and Setup Methods

Source: https://vtk.org/doc/nightly/html/classvtkXMLStatisticalModelReader.html

Methods for setting up output information and handling data selections.

```APIDOC
## SetupEmptyOutput

### Description
Initializes the current output.

### Method
void SetupEmptyOutput () override

## SetupOutputInformation

### Description
Sets up the output's information.

### Method
void SetupOutputInformation (vtkInformation *outInfo) override

## FillOutputPortInformation

### Description
Fills the output port information objects for this algorithm.

### Method
int FillOutputPortInformation (int, vtkInformation *)

## SetupOutputData

### Description
Sets up the output's data with allocation.

### Method
virtual void SetupOutputData ()

## CreateInformationKey

### Description
Creates a vtkInformationKey from its corresponding XML representation.

### Method
int CreateInformationKey (vtkXMLDataElement *eInfoKey, vtkInformation *info)

## ReadInformation

### Description
Populates the info object with the InformationKey children in infoRoot.

### Method
bool ReadInformation (vtkXMLDataElement *infoRoot, vtkInformation *info)

## SetDataArraySelections

### Description
Sets up the data array selections for the input's set of arrays.

### Method
void SetDataArraySelections (vtkXMLDataElement *eDSA, vtkDataArraySelection *sel)

## SetFieldDataInfo

### Description
Sets the field data information.

### Method
int SetFieldDataInfo (vtkXMLDataElement *eDSA, int association, vtkIdType numTuples, vtkInformationVector *(&infoVector))
```

--------------------------------

### Set and Get Start Theta

Source: https://vtk.org/doc/nightly/html/classvtkSphereSource.html

Methods to set and retrieve the starting longitude angle.

```APIDOC
## SetStartTheta()

### Description
Sets the starting longitude angle.
By default StartTheta=0 degrees.

### Method
`void SetStartTheta(double)`
```

```APIDOC
## GetStartTheta()

### Description
Retrieves the starting longitude angle.
By default StartTheta=0 degrees.

### Method
`double GetStartTheta()`
```

--------------------------------

### SetupActions

Source: https://vtk.org/doc/nightly/html/classvtkOpenVRInteractorStyle.html

Sets up default actions defined with an action path and a corresponding command.

```APIDOC
## SetupActions

### Description
Sets up default actions defined with an action path and a corresponding command.

### Method
void SetupActions(vtkRenderWindowInteractor *iren)

### Parameters
* **iren** (vtkRenderWindowInteractor *) - The interactor to set up actions for.
```

--------------------------------

### Starting Matrix Methods

Source: https://vtk.org/doc/nightly/html/classvtkOpenVRRenderWindowInteractor.html

Methods to get and set the starting physical to world matrix.

```APIDOC
## GetStartingPhysicalToWorldMatrix

### Description
Return starting physical to world matrix.

### Method
`virtual void GetStartingPhysicalToWorldMatrix(vtkMatrix4x4 *startingPhysicalToWorldMatrix)`

## SetStartingPhysicalToWorldMatrix

### Description
Set starting physical to world matrix.

### Method
`virtual void SetStartingPhysicalToWorldMatrix(vtkMatrix4x4 *startingPhysicalToWorldMatrix)`
```

--------------------------------

### SetupOutput

Source: https://vtk.org/doc/nightly/html/classvtkPStreamTracer-members.html

Sets up the output information for the stream tracer.

```APIDOC
## SetupOutput(vtkInformation *inInfo, vtkInformation *outInfo)

### Description
Sets up the output information for the stream tracer.

### Parameters
- **inInfo** (vtkInformation *) - Input information.
- **outInfo** (vtkInformation *) - Output information.

### Method
`SetupOutput`
```

--------------------------------

### Getting Start Position

Source: https://vtk.org/doc/nightly/html/classvtkHyperStreamline.html

Methods to retrieve the starting position of the hyperstreamline in global coordinates.

```APIDOC
## GetStartPosition

### Description
Get the start position of the hyperstreamline in global x-y-z coordinates.

### Method
double * GetStartPosition ()

### Returns
double* - Pointer to the array containing the global x-y-z coordinates.
```

--------------------------------

### Start()

Source: https://vtk.org/doc/nightly/html/classvtkRenderWidget.html

Starts the rendering process for the widget.

```APIDOC
## Start()

### Description
Starts the rendering process for the widget.

### Method
void
```

--------------------------------

### Get Begin Building Index

Source: https://vtk.org/doc/nightly/html/classvtkCityGMLReader.html

Get the starting index for the current building range being read.

```APIDOC
## GetBeginBuildingIndex

### Description
Get the starting index for the building range to read.

### Method
`virtual int GetBeginBuildingIndex()`

### Return Value
(int) - The starting index of the building range.
```

--------------------------------

### SetupFileView

Source: https://vtk.org/doc/nightly/html/classvtkPNrrdReader-members.html

Sets up the file view for reading.

```APIDOC
## SetupFileView

### Description
Sets up the file view for reading, typically used in parallel contexts.

### Method
`SetupFileView(vtkMPIOpaqueFileHandle &file, const int extent[6])`

### Parameters
*   **file** (vtkMPIOpaqueFileHandle &) - The file handle.
*   **extent** (const int[6]) - The extent of the data to be read.
```

--------------------------------

### Get Starting Position for Hyperstreamline

Source: https://vtk.org/doc/nightly/html/vtkHyperStreamline_8h_source.html

Retrieves the starting position of the hyperstreamline in global Cartesian coordinates.

```c++
double* GetStartPosition() VTK_SIZEHINT(3);
```

--------------------------------

### Start

Source: https://vtk.org/doc/nightly/html/classvtkExternalOpenGLRenderWindow.html

Begins the rendering process using the existing OpenGL context.

```APIDOC
## Start()

void vtkExternalOpenGLRenderWindow::Start()
overridevirtual
Begin the rendering process using the existing context.
Reimplemented from vtkRenderWindow.
```

--------------------------------

### GetCommentCharacters()

Source: https://vtk.org/doc/nightly/html/classvtkDelimitedTextReader.html

Gets the list of characters that can be used to start a comment section. Comments start at the first matching character.

```APIDOC
## GetCommentCharacters()

### Description
Gets the list of possible characters used to start comments section. Comment section will start at first matching character. Default is `#`.

### Method
virtual std::string

### Endpoint
N/A (Method of vtkDelimitedTextReader class)

### Parameters
None

### Response
- **std::string**: The list of comment characters.
```

--------------------------------

### SetupPalette

Source: https://vtk.org/doc/nightly/html/classvtkWin32OpenGLDXRenderWindow-members.html

Sets up the palette for the window using the provided device context. This is a virtual method.

```APIDOC
## SetupPalette

### Description
Sets up the palette for the window using the provided device context.

### Method
virtual void SetupPalette(HDC hDC)

### Parameters
* **hDC** (HDC) - The device context handle.
```

--------------------------------

### Set Major Range Start

Source: https://vtk.org/doc/nightly/html/TestAxisActorInternal_8h_source.html

Sets or gets the starting position for major tick points within the range.

```cpp
virtual void SetMajorRangeStart(double)
```

--------------------------------

### GetStartPiece

Source: https://vtk.org/doc/nightly/html/classvtkXMLPDataObjectWriter-members.html

Get the starting piece for writing.

```APIDOC
## GetStartPiece

### Description
Get the starting piece for writing.

### Method
virtual int GetStartPiece()

### Parameters
None

### Response
- **int**: The starting piece index.
```

--------------------------------

### Begin

Source: https://vtk.org/doc/nightly/html/classvtkContextDevice2D.html

Begin drawing, pass in the viewport to set up the view. This is an inline virtual method.

```APIDOC
## Begin()

### Description
Begin drawing, pass in the viewport to set up the view.

### Method
virtual void Begin(vtkViewport * __)

### Parameters
#### Path Parameters
- **__** (vtkViewport *) - Required - The viewport to set up the view.
```

--------------------------------

### GetStartAngle

Source: https://vtk.org/doc/nightly/html/classvtkSectorSource.html

Get the start angle of the sector.

```APIDOC
## GetStartAngle()

### Description
Returns the start angle of the sector.

### Method
GET

### Endpoint
/GetStartAngle

### Returns
- **double**: The current start angle of the sector in degrees.
```

--------------------------------

### SetupPalette

Source: https://vtk.org/doc/nightly/html/functions_func_s.html

Sets up the color palette for rendering windows.

```APIDOC
## SetupPalette()

### Description
Configures the color palette used for rendering in different windowing systems.

### Method
(Not specified)

### Returns
vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow
```

--------------------------------

### GetCursorStartPosition

Source: https://vtk.org/doc/nightly/html/classvtkParallelCoordinatesInteractorStyle-members.html

Get the starting position of the cursor.

```APIDOC
## GetCursorStartPosition

### Description
Get the starting position of the cursor.

### Method
protected

### Parameters
None

### Response
- **int** - The starting X position of the cursor.
- **int** - The starting Y position of the cursor.

### Response Example
```json
{
  "x": 80,
  "y": 180
}
```
```

--------------------------------

### SetupOutputInformation

Source: https://vtk.org/doc/nightly/html/classvtkPhyloXMLTreeReader.html

Sets up the output's information.

```APIDOC
## SetupOutputInformation

### Description
Setup the output's information.

### Method
virtual void SetupOutputInformation(vtkInformation *outInfo)

### Parameters
- **outInfo** (vtkInformation *) - The output information object.
```

--------------------------------

### Start()

Source: https://vtk.org/doc/nightly/html/classvtkZSpaceWin32RenderWindow-members.html

Starts the rendering process. This method is part of the vtkZSpaceWin32RenderWindow's virtual interface.

```APIDOC
## Start()

### Description
Starts the rendering process.

### Method
virtual void Start()

### Endpoint
N/A (Method call)
```

--------------------------------

### GetStartTheta

Source: https://vtk.org/doc/nightly/html/classvtkPSphereSource-members.html

Get the starting longitude of the sphere.

```APIDOC
## GetStartTheta

### Description
Get the starting longitude of the sphere.

### Method
GetStartTheta()

### Return Value
double - Starting longitude of the sphere.
```

--------------------------------

### GetStartPhi

Source: https://vtk.org/doc/nightly/html/classvtkPSphereSource-members.html

Get the starting latitude of the sphere.

```APIDOC
## GetStartPhi

### Description
Get the starting latitude of the sphere.

### Method
GetStartPhi()

### Return Value
double - Starting latitude of the sphere.
```

--------------------------------

### Initialize

Source: https://vtk.org/doc/nightly/html/vtkOpenVRRenderWindow_8h_source.html

Initializes the rendering window and sets up OpenVR context.

```APIDOC
## Initialize

### Description
Initialize the rendering window.

### Method
void

### Endpoint
vtkOpenVRRenderWindow::Initialize
```

--------------------------------

### SetupNextPiece

Source: https://vtk.org/doc/nightly/html/classvtkXMLUnstructuredDataReader.html

Reimplemented in vtkXMLPolyDataReader, and vtkXMLUnstructuredGridReader.

```APIDOC
## SetupNextPiece()

### Description
Sets up the reader for processing the next piece of data. This method is virtual and reimplemented in subclasses.

### Method
void

### Endpoint
N/A (C++ method)

### Parameters
None

### Response
None
```

--------------------------------

### GetStartPosition

Source: https://vtk.org/doc/nightly/html/classvtkEvenlySpacedStreamlines2D-members.html

Gets the starting position of the streamlines.

```APIDOC
## GetStartPosition

### Description
Gets the starting position of the streamlines.

### Method
virtual void GetStartPosition(double[3])
```

--------------------------------

### Start

Source: https://vtk.org/doc/nightly/html/classvtkCocoaRenderWindow.html

Begins the rendering process for the window.

```APIDOC
## Start()

void vtkCocoaRenderWindow::Start()
overridevirtual
Begin the rendering process.
```

--------------------------------

### Start()

Source: https://vtk.org/doc/nightly/html/classvtkZSpaceWin32RenderWindow.html

Begins the rendering process. Overridden to notify the zSpace SDK for the beginning of a frame as early as possible to improve tracking. Reimplemented from vtkOpenGLRenderWindow.

```APIDOC
## Start()

void vtkZSpaceWin32RenderWindow::Start()
override virtual

Begin the rendering process.
Overridden to notify the zSpace SDK for the beginning of a frame as early as possible. This is useful to improve tracking.
Reimplemented from vtkOpenGLRenderWindow.
```

--------------------------------

### vtkStridedArray::GetStride

Source: https://vtk.org/doc/nightly/html/vtkStridedArray_8h_source.html

Gets the stride of the strided backend. The stride is the number of elements between the start of one element and the start of the next.

```APIDOC
## vtkStridedArray::GetStride

### Description
Gets the stride of the strided backend. The stride is the number of elements between the start of one element and the start of the next.

### Method
vtkIdType GetStride() const

### Response
#### Success Response (200)
- **Return Value** (vtkIdType) - The stride of the backend.
```

--------------------------------

### Get Start Index

Source: https://vtk.org/doc/nightly/html/vtkPixelExtent_8h_source.html

Retrieves the starting indices (ilo, jlo) of the pixel extent and stores them in the provided first array.

```C++
inline void vtkPixelExtent::GetStartIndex(int first[2]) const
{
  first[0] = this->Data[0];
  first[1] = this->Data[2];
}
```

--------------------------------

### SetupEmptyOutput

Source: https://vtk.org/doc/nightly/html/classvtkPhyloXMLTreeReader.html

Sets up the output with no data available.

```APIDOC
## SetupEmptyOutput

### Description
Setup the output with no data available.

### Method
void SetupEmptyOutput() override
```

--------------------------------

### Get Starting Location for Hyperstreamline

Source: https://vtk.org/doc/nightly/html/vtkHyperStreamline_8h_source.html

Retrieves the starting location of the hyperstreamline, including the cell ID, sub-ID, and parametric coordinates.

```c++
vtkIdType GetStartLocation(int& subId, double pcoords[3]);
```

--------------------------------

### Begin

Source: https://vtk.org/doc/nightly/html/classvtkContext2D.html

Begins painting on a vtkContextDevice2D. This must be called before any painting operations.

```APIDOC
## Begin(vtkContextDevice2D *_device)

### Description
Begins painting on a vtkContextDevice2D, no painting can occur before this call has been made. Only one painter is allowed at a time on any given paint device. Returns true if successful, otherwise false.

### Method
bool

### Parameters
#### Path Parameters
* **_device** (vtkContextDevice2D *) - The device to paint on.
```

--------------------------------

### GetStartPiece

Source: https://vtk.org/doc/nightly/html/classvtkXMLPMultiBlockDataWriter.html

Gets the starting piece for the range of pieces assigned to this writer. This method returns the configured start piece for the writer.

```APIDOC
## GetStartPiece()

### Description
Gets the range of pieces assigned to this writer.

### Method
virtual int

### Parameters
None provided in source.
```

--------------------------------

### SetupActions

Source: https://vtk.org/doc/nightly/html/functions_func_s.html

Sets up actions for VR/XR interactor styles.

```APIDOC
## SetupActions()

### Description
Sets up actions for VR and XR interactor styles.

### Method
(Not specified, likely a constructor or initialization method)

### Returns
vtkOpenVRInteractorStyle, vtkOpenXRInteractorStyle, vtkVRInteractorStyle, vtkWebXRInteractorStyle
```

--------------------------------

### GetStartTimeStamp

Source: https://vtk.org/doc/nightly/html/classvtkVideoSource-members.html

Gets the start timestamp of the video source.

```APIDOC
## GetStartTimeStamp

### Description
Gets the start timestamp of the video source.

### Method
inline

### Signature
GetStartTimeStamp()
```

--------------------------------

### SetupActions

Source: https://vtk.org/doc/nightly/html/classvtkVRInteractorStyle.html

Sets up default actions defined with an action path and a corresponding command. This is a pure virtual function implemented in derived classes like vtkOpenVRInteractorStyle, vtkOpenXRInteractorStyle, and vtkWebXRInteractorStyle.

```APIDOC
## SetupActions()

### Description
Sets up default actions defined with an action path and a corresponding command.

### Signature
`virtual void vtkVRInteractorStyle::SetupActions(vtkRenderWindowInteractor * _iren_)`

### Remarks
Pure virtual. Implemented in vtkOpenVRInteractorStyle, vtkOpenXRInteractorStyle, and vtkWebXRInteractorStyle.
```

--------------------------------

### SetupForCopy

Source: https://vtk.org/doc/nightly/html/classvtkDataSetAttributes.html

Creates a mapping between input and output attributes for efficient data copying. Assumes arrays are identical and ordered the same.

```APIDOC
## SetupForCopy()

### Description
Create a mapping between the input attributes and this object so that methods like CopyData() and CopyStructuredData() can be called. This method assumes that this object has the same arrays as the input and that they are ordered the same way (same array indices).

### Method
void

### Signature
SetupForCopy(vtkDataSetAttributes * _pd_)
```

--------------------------------

### GetRootStartAngle

Source: https://vtk.org/doc/nightly/html/classvtkStackedTreeLayoutStrategy.html

Gets the start angle for the root node.

```APIDOC
## GetRootStartAngle

### Description
Define the start angle for the root node.

### Method
double GetRootStartAngle()

### Returns
- (double) - The current root start angle.
```

--------------------------------

### StartWipePosition

Source: https://vtk.org/doc/nightly/html/classvtkRectilinearWipeRepresentation.html

Gets or sets the starting position of the wipe.

```APIDOC
## StartWipePosition

### Description
Gets or sets the starting position (an array of 2 doubles) for the wipe effect.

### Member Type
`double[2]`

### Access
Protected
```

--------------------------------

### SetUploaded

Source: https://vtk.org/doc/nightly/html/functions_func_s.html

Sets the uploaded status for an OpenGL array texture buffer adapter.

```APIDOC
## SetUploaded()

### Description
Marks the texture buffer as uploaded to the GPU.

### Method
(Not specified)

### Returns
vtkOpenGLArrayTextureBufferAdapter
```

--------------------------------

### SetupEmptyOutput Method

Source: https://vtk.org/doc/nightly/html/vtkXMLCompositeDataReader_8h_source.html

Sets up an empty output, typically used in error cases.

```cpp
// Setup the output with no data available. Used in error cases.
void SetupEmptyOutput() override;
```

--------------------------------

### GetStartPiece

Source: https://vtk.org/doc/nightly/html/classvtkPDataSetWriter-members.html

Get the starting piece index for the writer.

```APIDOC
## GetStartPiece

### Description
Get the starting piece index for the writer.

### Method
virtual int GetStartPiece() const

### Return Value
The starting piece index.
```

--------------------------------

### SetupGraphicsPipelines Method

Source: https://vtk.org/doc/nightly/html/vtkWebGPUPolyDataMapper_8h_source.html

Sets up the WebGPU graphics pipelines for rendering, based on the device, renderer, and actor.

```c++
void SetupGraphicsPipelines(const wgpu::Device& device, vtkRenderer* renderer, vtkActor* actor);

```

--------------------------------

### GetInstallMessageProc

Source: https://vtk.org/doc/nightly/html/classvtkWin32RenderWindowInteractor-members.html

Get the install message procedure flag.

```APIDOC
## GetInstallMessageProc

### Description
Get the install message procedure flag.

### Method
virtual

### Endpoint
GetInstallMessageProc()
```

--------------------------------

### GetOffset

Source: https://vtk.org/doc/nightly/html/classvtkMaskPolyData.html

Gets the starting entity (cell) to consider.

```APIDOC
## GetOffset

### Description
Start with this entity (cell).

### Method
`virtual vtkIdType GetOffset()`
```

--------------------------------

### Start()

Source: https://vtk.org/doc/nightly/html/classvtkXOpenGLRenderWindow.html

Begins the rendering process. This method is an override from the superclass.

```APIDOC
## Start()

### Description
Begins the rendering process.

### Method
override virtual

### Signature
void vtkXOpenGLRenderWindow::Start()

### Remarks
Reimplemented from vtkOpenGLRenderWindow.
```

--------------------------------

### GetGLBStart

Source: https://vtk.org/doc/nightly/html/classvtkGLTFDocumentLoader.html

Gets the starting offset for the GLB stream.

```APIDOC
## GetGLBStart()

### Description
Set/Get the Stream start, where the GLB starts. By default it is 0, but can be different than 0 for file formats have a GLB embedded in it, for instance 3D Tiles B3DM.

### Method
virtual vtkTypeInt64 vtkGLTFDocumentLoader::GetGLBStart()
```

--------------------------------

### SetupPixelFormatPaletteAndContext

Source: https://vtk.org/doc/nightly/html/classvtkWin32OpenGLDXRenderWindow.html

Initialize OpenGL for this window.

```APIDOC
## SetupPixelFormatPaletteAndContext

### Description
Initialize OpenGL for this window.

### Method
`virtual void SetupPixelFormatPaletteAndContext (HDC hDC, DWORD dwFlags, int debug, int bpp=16, int zbpp=16)`
```

--------------------------------

### SetupInformation

Source: https://vtk.org/doc/nightly/html/classvtkHDFReader.html

Setup the information pass in parameter based on current vtkHDF file loaded.

```APIDOC
## SetupInformation

### Description
Setup the information pass in parameter based on current vtkHDF file loaded.

### Method
int SetupInformation(vtkInformation *outInfo)

### Parameters
#### Path Parameters
- None

#### Query Parameters
- None

#### Request Body
- **outInfo** (vtkInformation*) - The information object to be set up.

### Response
#### Success Response (int)
Returns 1 on success, 0 on failure.

### Request Example
```
reader->SetupInformation(info);
```

### Response Example
```
1
```
```

--------------------------------

### GetBeginAtomId

Source: https://vtk.org/doc/nightly/html/classvtkBond.html

Get the starting atom id for this bond.

```APIDOC
## GetBeginAtomId

### Description
Get the starting atom id for this bond.

### Method
`vtkIdType GetBeginAtomId() const`

### Return Value
The ID of the starting atom.
```

--------------------------------

### GetInstallMessageProc

Source: https://vtk.org/doc/nightly/html/functions_func_g.html

Gets the message procedure installation status for vtkWin32RenderWindowInteractor.

```APIDOC
## GetInstallMessageProc()

### Description
Gets the message procedure installation status for vtkWin32RenderWindowInteractor.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None

### Request Example
None

### Response
- **Return Value**: vtkWin32RenderWindowInteractor
```

--------------------------------

### Initialization and Setup

Source: https://vtk.org/doc/nightly/html/vtkAnariDevice_8h_source.html

Methods for initializing and configuring the ANARI device.

```APIDOC
## vtkAnariDevice::New

### Description
Creates a new instance of vtkAnariDevice.

### Method
static vtkAnariDevice*

### Endpoint
N/A (Constructor)

## vtkAnariDevice::vtkAnariDevice

### Description
Default constructor for vtkAnariDevice.

### Method
vtkAnariDevice()

### Endpoint
N/A (Constructor)

## vtkAnariDevice::~vtkAnariDevice

### Description
Destructor for vtkAnariDevice.

### Method
~vtkAnariDevice() override

### Endpoint
N/A (Destructor)

## vtkAnariDevice::SetupAnariDeviceFromLibrary

### Description
Initializes this vtkAnariDevice from the name of an anari::Library and anari::Device to be loaded.

### Method
bool SetupAnariDeviceFromLibrary(const char* libraryName, const char* deviceName, bool enableDebugLayer = false)

### Endpoint
N/A (Method Call)

## vtkAnariDevice::AnariInitialized

### Description
Checks if ANARI has been initialized with SetupAnariDeviceFromLibrary.

### Method
bool AnariInitialized() const

### Endpoint
N/A (Method Call)

## vtkAnariDevice::SetAnariDebugConfig

### Description
Sets up the trace directory and trace mode strings for the debug device for when SetupAnariDeviceFromLibrary is called.

### Method
void SetAnariDebugConfig(const char* traceDir, const char* traceMode)

### Endpoint
N/A (Method Call)
```

--------------------------------

### SetupEmptyOutput

Source: https://vtk.org/doc/nightly/html/classvtkXMLReader-members.html

Pure virtual method to set up an empty output data object.

```APIDOC
## SetupEmptyOutput

### Description
Pure virtual method that must be implemented by subclasses to set up an empty output data object.

### Method
`SetupEmptyOutput()=0`
```

--------------------------------

### vtkImageChangeInformation::GetOutputExtentStart

Source: https://vtk.org/doc/nightly/html/vtkImageChangeInformation_8h_source.html

Gets the starting index of the output extent.

```APIDOC
## vtkImageChangeInformation::GetOutputExtentStart

### Description
Gets the starting index of the output extent for the image.

### Method
vtkGetVector3Macro(OutputExtentStart, int);
```

--------------------------------

### SetupFileView

Source: https://vtk.org/doc/nightly/html/functions_func_s.html

Sets up file view for MPI and NRRD readers.

```APIDOC
## SetupFileView()

### Description
Configures the file view settings, likely for parallel reading or specific file access patterns.

### Method
(Not specified)

### Returns
vtkMPIImageReader, vtkPNrrdReader
```

--------------------------------

### GetStartTuple

Source: https://vtk.org/doc/nightly/html/classvtkXMLPolyDataReader.html

Utility method for subclasses to get the starting tuple.

```APIDOC
## GetStartTuple

### Description
Utility method for subclasses to get the starting tuple.

### Method Signature
`vtkIdType GetStartTuple(VTK_FUTURE_CONST int extent[6], vtkIdType *increments, int i, int j, int k)`
```

--------------------------------

### GetOffset

Source: https://vtk.org/doc/nightly/html/classvtkRuledSurfaceFilter.html

Gets the current setting for the starting stripe that is visible.

```APIDOC
## GetOffset()

### Description
Control the striping of the ruled surface. The offset sets the first stripe that is visible. Offset is generally used with OnRatio to create nifty striping effects.

### Method
virtual int

### Parameters
None
```

--------------------------------

### SetupEmptyOutput

Source: https://vtk.org/doc/nightly/html/classvtkXMLGenericDataObjectReader.html

Sets up an empty output. This method is overridden but not used, as its functionality is delegated.

```APIDOC
## SetupEmptyOutput()

### Description
Sets up an empty output. This method is overridden but not used, as its functionality is delegated.

### Method
(Not specified, likely a setter/setup method)

### Endpoint
(Not applicable, SDK method)

### Parameters
None

### Response
(void return type, no specific response)
```

--------------------------------

### Get Side Set List Index

Source: https://vtk.org/doc/nightly/html/vtkModelMetadata_8h_source.html

Gets a list of the index of the starting entry for each side set in the list of side set side IDs.

```APIDOC
## GetSideSetListIndex

### Description
Gets a list of the index of the starting entry for each side set in the list of side set side IDs.

### Method
`int * GetSideSetListIndex() const`
```

--------------------------------

### Output Information and Setup

Source: https://vtk.org/doc/nightly/html/classvtkRTXMLPolyDataReader.html

Methods for setting up the output data structures and information.

```APIDOC
## SetupOutputData

### Description
Sets up the output's data with allocation. This is called during pipeline execution.

### Method
`void SetupOutputData() override
`
```

```APIDOC
## SetupOutputData

### Description
Sets up the output's data with allocation. This is called during pipeline execution.

### Method
`void SetupOutputData() override
`
```

```APIDOC
## SetupOutputInformation

### Description
Sets up the output's information object.

### Method
`void SetupOutputInformation(vtkInformation *outInfo) override
`
```

```APIDOC
## FillOutputPortInformation

### Description
Fills the output port information objects for this algorithm.

### Method
`int FillOutputPortInformation(int, vtkInformation *)
`
```

--------------------------------

### Initialize

Source: https://vtk.org/doc/nightly/html/classvtkWebGPURenderWindow-members.html

Initializes the WebGPU render window, setting up the necessary graphics context and resources.

```APIDOC
## Initialize

### Description
Initializes the `vtkWebGPURenderWindow`. This method should be called after the render window has been created and configured, but before any rendering operations begin. It sets up the underlying WebGPU device and context.

### Method
`virtual void Initialize() override`
```

--------------------------------

### vtkXMLPUnstructuredDataReader::StartPoint

Source: https://vtk.org/doc/nightly/html/vtkXMLPUnstructuredDataReader_8h_source.html

Gets the starting point index for the current piece.

```APIDOC
## StartPoint

### Description
Gets the starting point index for the current piece.

### Method
vtkIdType

### Definition
vtkXMLPUnstructuredDataReader.h:82
```

--------------------------------

### SetupOutputTotals

Source: https://vtk.org/doc/nightly/html/classvtkXMLUnstructuredDataReader.html

Reimplemented in vtkXMLPolyDataReader, and vtkXMLUnstructuredGridReader.

```APIDOC
## SetupOutputTotals()

### Description
Sets up the total output for the reader. This method is virtual and reimplemented in subclasses.

### Method
void

### Endpoint
N/A (C++ method)

### Parameters
None

### Response
None
```

--------------------------------

### vtkTemporalFractal::StartBlock

Source: https://vtk.org/doc/nightly/html/vtkTemporalFractal_8h_source.html

Gets the starting block index for the current level.

```APIDOC
## vtkTemporalFractal::StartBlock

### Description
Gets the starting block index for the current level.

### Property
int StartBlock

### Returns
The starting block index.
```

--------------------------------

### vtkRectilinearWipeRepresentation::StartWipePosition

Source: https://vtk.org/doc/nightly/html/vtkRectilinearWipeRepresentation_8h_source.html

Get the starting position of the wipe. This is a property of the representation.

```APIDOC
## StartWipePosition

### Description
Starting position of the wipe.

### Field
double StartWipePosition[2]

### Definition
vtkRectilinearWipeRepresentation.h:164
```

--------------------------------

### SetupPieces()

Source: https://vtk.org/doc/nightly/html/classvtkXMLRectilinearGridReader.html

Sets up the pieces for reading the dataset.

```APIDOC
## SetupPieces()
| void vtkXMLRectilinearGridReader::SetupPieces  | ( | int | _numPieces_| ) |   
---|---|---|---|---|---
overrideprotectedvirtual

Reimplemented from vtkXMLDataReader.
```

--------------------------------

### vtkRadialGridActor2D::GetStartAngle

Source: https://vtk.org/doc/nightly/html/vtkRadialGridActor2D_8h_source.html

Gets the starting angle of the radial grid axes.

```APIDOC
## vtkRadialGridActor2D::GetStartAngle

### Description
Gets the starting angle (in degrees) of the radial grid axes.

### Method
double GetStartAngle()

### Return Value
The starting angle in degrees.
```

--------------------------------

### vtkOpenVROverlay::SetupSpots

Source: https://vtk.org/doc/nightly/html/vtkOpenVROverlay_8h_source.html

Sets up the overlay spots.

```APIDOC
## vtkOpenVROverlay::SetupSpots

### Description
Setup the overlay spots.

### Method
virtual void

### Parameters
None
```

--------------------------------

### SetupCompressor

Source: https://vtk.org/doc/nightly/html/classvtkXMLPPolyDataReader.html

Sets up the compressor for data compression. Internal utility method.

```APIDOC
## SetupCompressor

### Description
Sets up the compressor for data compression. Internal utility method.

### Signature
`void SetupCompressor(const char *type)`
```

--------------------------------

### vtkInteractorStyleRubberBand2D::StartPosition

Source: https://vtk.org/doc/nightly/html/vtkInteractorStyleRubberBand2D_8h_source.html

Gets the starting position of the rubber band selection.

```APIDOC
## vtkInteractorStyleRubberBand2D::StartPosition

### Description
Gets the starting 2D screen coordinates (x, y) where the rubber band selection began.

### Method
vtkGetVector2Macro(StartPosition, int)

```

--------------------------------

### vtkBond::GetEndAtomId

Source: https://vtk.org/doc/nightly/html/vtkBond_8h_source.html

Get the starting / ending atom ids for this bond.

```APIDOC
## vtkBond::GetEndAtomId

### Description
Get the starting / ending atom ids for this bond.

### Method
vtkIdType GetEndAtomId() const

### Definition
vtkBond.h:41
```

--------------------------------

### SetupOutput

Source: https://vtk.org/doc/nightly/html/functions_func_s.html

Sets up the output for streamline filters and tessellators.

```APIDOC
## SetupOutput()

### Description
Configures the output structure for streamline generation or geometric tessellation.

### Method
(Not specified)

### Returns
vtkEvenlySpacedStreamlines2D, vtkStreamTracer, vtkTessellatorFilter
```

--------------------------------

### Compressor Setup

Source: https://vtk.org/doc/nightly/html/classvtkXMLPImageDataReader.html

Internal utility method for setting up the compressor.

```APIDOC
## SetupCompressor
### Description
Sets up the compressor with the given type. Internal utility method.

### Parameters
- `type` (const char*): The type of the compressor.
```

--------------------------------

### vtkBond::GetBeginAtomId

Source: https://vtk.org/doc/nightly/html/vtkBond_8h_source.html

Get the starting / ending atom ids for this bond.

```APIDOC
## vtkBond::GetBeginAtomId

### Description
Get the starting / ending atom ids for this bond.

### Method
vtkIdType GetBeginAtomId() const

### Definition
vtkBond.h:41
```
Tokens:
Raw