3ds Max C++ API Reference

https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF
Admin
Comprehensive documentation for the 3ds Max C++ API, providing developers with technical reference...
Tokens:22,424,004
Snippets:162,198
Trust Score:9.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_number.html

Performs setup operations for the Number class.

```APIDOC
## ◆ setup()

### Description
Initializes or sets up necessary internal structures for the Number class operations.

### Signature
`static void setup()`

### Example
```cpp
Number::setup();
```
```

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

### Start Method

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_max_s_d_k_1_1_util_1_1_stop_watch.html

Starts the timer and sets its state to PLAYING.

```APIDOC
## Start()

### Description
This method lets you start to trace the time and changes the current state to PLAYING.

### Method
void Start()

### Parameters
None

### Returns
None
```

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

### Start() - Get Start Time

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interval.html

Returns the start time of the interval.

```APIDOC
## Start()

### Description
Returns the start time of the interval.

### Returns
* **TimeValue** - The start time of the interval.

### Code Example
```cpp
TimeValue Start() const;
```
```

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

### setup()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_m_a_x_key.html

Static function to set up MAXKey.

```APIDOC
## setup()
| void setup  | ( | __| ) |   
---|---|---|---|---
static
```

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

### Get Start Offset

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_space_array_callback.html

Retrieves the start offset value. Implemented by the System.

```cpp
inline float getStart(void) { return start; }
```

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

### setup()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_parser.html

Sets up the parser.

```APIDOC
## ◆ setup()
| void setup  | ( | __| )
```

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

### Render Start Time

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface11.html

Functions to get and set the render start time.

```APIDOC
## GetRendStart

### Description
Gets the render start time.

### Method
`virtual TimeValue GetRendStart() = 0;`

## SetRendStart

### Description
Sets the render start time.

### Method
`virtual void SetRendStart(TimeValue start) = 0;`
```

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

### setup()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_m_a_x_class.html

Initializes the MAXClass system. This function should be called during application startup.

```APIDOC
## setup()

### Description
Initializes the MAXClass system. This function should be called during application startup.

### Method
static void

### Endpoint
N/A (Static function)

### Parameters
None

### Request Example
N/A

### Response
None
```

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

### Background Start Time

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface11.html

Functions to set and get the background start time.

```APIDOC
## setBkgStartTime

### Description
Sets the background start time.

### Method
`virtual void setBkgStartTime(TimeValue t) = 0;`

## getBkgStartTime

### Description
Gets the background start time.

### Method
`virtual TimeValue getBkgStartTime() = 0;`
```

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

### setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface_method-members.html

Sets up the object with a given size.

```APIDOC
## setup

### Description
Sets up the object with a given size.

### Method
`static`

### Signature
`Collectable setup(size_t)`
```

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

### setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_collectable.html

Sets up the garbage collection system with a specified size.

```APIDOC
## setup(size_t)

### Description
Sets up the garbage collection system with a specified size.

### Method
setup

### Parameters
#### Path Parameters
- **size** (size_t) - The size to set up the GC with.
```

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

### Get Animation Start Time

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/control_8h.html

Retrieves the start time of the current animation range.

```cpp
CoreExport TimeValue GetAnimStart  | ( | __| ) |   
```

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

### Start Frame

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_mocap_manager.html

Functions to get and set the start frame for motion capture sequences.

```APIDOC
## GetStartFrame

### Description
Retrieves the current start frame number.

### Method
`GetStartFrame`

### Return Value
Returns an integer representing the start frame.

## SetStartFrame

### Description
Sets the start frame number for motion capture sequences.

### Method
`SetStartFrame`

### Parameters
- **val** (int) - The start frame number to set.
```

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

### setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_m_a_x_control-members.html

Sets up a Collectable object with a given size.

```APIDOC
## setup

### Description
Sets up a Collectable object with a given size.

### Method
static

### Parameters
- **size** (size_t) - 
```

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

### setup(size_t)

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_function-members.html

Sets up the object with a given size.

```APIDOC
## setup(size_t)

### Description
Initializes or configures the object with a specified size.

### Method
(Static member, not a function call)

### Endpoint
(Not applicable for SDK functions)

### Parameters
- **size** (size_t) - The size to use for setup.

### Response
(Details not specified)
```

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

### Start Primitive Offset

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_max_s_d_k_1_1_graphics_1_1_viewport_instancing_1_1_instance_display_geometry.html

Functions to get and set the starting primitive offset for drawing.

```APIDOC
## GetStartPrimitive() const override

### Description
Gets the starting primitive index for drawing.

### Returns
int - The starting primitive index.
```

```APIDOC
## SetStartPrimitive(int offset)

### Description
Sets the starting primitive offset for drawing.

### Parameters
#### Request Body
- **offset** (int) - Required - The starting primitive offset.
```

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

### setup(size_t)

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_static_interface_method-members.html

Sets up the Collectable system with a given size. This is a static method.

```APIDOC
## setup(size_t)

### Description
Sets up the Collectable system with a given size.

### Parameters
- **size** (size_t) - The size to set up.

### Method
static

### Class
Collectable
```

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

### Start Primitive Offset Management

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_max_s_d_k_1_1_graphics_1_1_simple_render_geometry.html

Methods for setting and getting the start primitive offset for drawing.

```APIDOC
## Start Primitive Offset Management

### SetStartPrimitive

#### Description
Sets the start primitive offset for drawing.

#### Method
`void SetStartPrimitive(int offset)`

#### Parameters
*   `offset` (int) - The offset for the starting primitive.

### GetStartPrimitive

#### Description
Gets the start primitive offset.

#### Method
`int GetStartPrimitive() const`
```

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

### Initialization and Setup Functions

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/globals_func_g.html

Functions related to initialization and setup.

```APIDOC
## GetCPInitPos()

### Description
Gets the initial position for CP (Control Panel).

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Position data

## GetCreaseSetManager()

### Description
Retrieves the Crease Set Manager.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Crease Set Manager object

## GetCUIFrameMgr()

### Description
Retrieves the Custom User Interface (CUI) Frame Manager.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
CUI Frame Manager object

## GetDADBitmapCarrier()

### Description
Retrieves the DAD Bitmap Carrier.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
DAD Bitmap Carrier object

## GetDefaultController()

### Description
Retrieves the default controller.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Default controller object

## GetDefaultUIColor()

### Description
Retrieves the default UI color.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Default UI color value

## GetDKGrayBrush()

### Description
Retrieves the DKGray brush.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
DKGray brush object

## GetDlgItemFloat()

### Description
Retrieves a float value from a dialog item.

### Method
Call

### Endpoint
N/A

### Parameters
- **hwnd** (HWND) - Handle to the dialog window.
- **id** (int) - The ID of the dialog item.

### Request Example
None

### Response
Float value

## GetDragAndDropMgr()

### Description
Retrieves the Drag and Drop Manager.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Drag and Drop Manager object

## GetDummyObjDesc()

### Description
Retrieves the descriptor for a dummy object.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Dummy object descriptor

## GetDXShaderManager()

### Description
Retrieves the DX Shader Manager.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
DX Shader Manager object

## GetEditPolyObjDesc()

### Description
Retrieves the descriptor for an editable poly object.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Editable poly object descriptor

## GetEditTriObjDesc()

### Description
Retrieves the descriptor for an editable tri object.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Editable tri object descriptor

## GetExposureMaterialControl()

### Description
Retrieves the Exposure Material Control interface.

### Method
Call

### Endpoint
N/A

### Parameters
None

### Request Example
None

### Response
Exposure Material Control interface
```

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

### Curve Start Point

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_n_u_r_b_s_lathe_surface.html

Functions to set and get the starting point of the curve for the NURBSLatheSurface at a specific time.

```APIDOC
## SetCurveStartPoint (TimeValue t, double startpoint)

### Description
Sets the starting point of the curve for the NURBSLatheSurface at a given time.

### Method
void

### Parameters
#### Path Parameters
- **t** (TimeValue) - The time at which to set the curve start point.
- **startpoint** (double) - The new curve start point value.
```

```APIDOC
## GetCurveStartPoint (TimeValue t)

### Description
Retrieves the starting point of the curve for the NURBSLatheSurface at a given time.

### Method
double

### Parameters
#### Path Parameters
- **t** (TimeValue) - The time at which to retrieve the curve start point.
```

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

### Setup and Configuration Methods

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface15-members.html

Methods for setting up rendering parameters and configuring various scene and viewport settings.

```APIDOC
## SetupFrameRendParams

### Description
Sets up frame rendering parameters.

### Method
`SetupFrameRendParams(FrameRendParams &frp, RendParams &rp, ViewExp *vx, RECT *r)`

### Parameters
- **frp** (FrameRendParams &) - Reference to FrameRendParams structure.
- **rp** (RendParams &) - Reference to RendParams structure.
- **vx** (ViewExp *) - Pointer to the ViewExp object.
- **r** (RECT *) - Pointer to a RECT structure.
```

```APIDOC
## SetupFrameRendParams_MXS

### Description
Sets up frame rendering parameters, including selection box usage.

### Method
`SetupFrameRendParams_MXS(FrameRendParams &frp, RendParams &rp, ViewExp *vx, RECT *r, bool useSelBox)`

### Parameters
- **frp** (FrameRendParams &) - Reference to FrameRendParams structure.
- **rp** (RendParams &) - Reference to RendParams structure.
- **vx** (ViewExp *) - Pointer to the ViewExp object.
- **r** (RECT *) - Pointer to a RECT structure.
- **useSelBox** (bool) - TRUE to use selection box, FALSE otherwise.
```

```APIDOC
## SetupRendParams

### Description
Sets up rendering parameters for a given viewport and render type.

### Method
`SetupRendParams(RendParams &rp, ViewExp *vpt, RendType t=RENDTYPE_NORMAL)`

### Parameters
- **rp** (RendParams &) - Reference to RendParams structure.
- **vpt** (ViewExp *) - Pointer to the ViewExp object.
- **t** (RendType, optional) - The type of rendering. Defaults to RENDTYPE_NORMAL.
```

```APIDOC
## SetUseCodePageSpecifiedInSceneFile

### Description
Specifies whether to use the code page defined in the scene file.

### Method
`SetUseCodePageSpecifiedInSceneFile(bool useFileCodePage)`

### Parameters
- **useFileCodePage** (bool) - TRUE to use the scene file's code page, FALSE otherwise.
```

```APIDOC
## SetUseDraftRenderer

### Description
Enables or disables the use of the draft renderer.

### Method
`SetUseDraftRenderer(BOOL b)`

### Parameters
- **b** (BOOL) - TRUE to use the draft renderer, FALSE otherwise.
```

```APIDOC
## SetUseEnvironmentMap

### Description
Enables or disables the use of the environment map.

### Method
`SetUseEnvironmentMap(BOOL onOff)`

### Parameters
- **onOff** (BOOL) - TRUE to enable the environment map, FALSE to disable.
```

```APIDOC
## SetUseGridColor

### Description
Enables or disables the use of grid color.

### Method
`SetUseGridColor(BOOL b)`

### Parameters
- **b** (BOOL) - TRUE to use grid color, FALSE otherwise.
```

```APIDOC
## SetUsePostRendScript

### Description
Enables or disables the use of post-render scripts.

### Method
`SetUsePostRendScript(BOOL onOff)`

### Parameters
- **onOff** (BOOL) - TRUE to enable post-render scripts, FALSE to disable.
```

```APIDOC
## SetUsePreRendScript

### Description
Enables or disables the use of pre-render scripts.

### Method
`SetUsePreRendScript(BOOL onOff)`

### Parameters
- **onOff** (BOOL) - TRUE to enable pre-render scripts, FALSE to disable.
```

```APIDOC
## SetUseTransformGizmo

### Description
Enables or disables the use of the transform gizmo.

### Method
`SetUseTransformGizmo(BOOL onOff)`

### Parameters
- **onOff** (BOOL) - TRUE to enable the transform gizmo, FALSE to disable.
```

```APIDOC
## SetViewportBGColor

### Description
Sets the background color for the active viewport.

### Method
`SetViewportBGColor(const Point3 &color)`

### Parameters
- **color** (const Point3 &) - The Point3 representing the RGB color.
```

```APIDOC
## SetViewportGridVisible

### Description
Sets the visibility of the grid in a specific viewport.

### Method
`SetViewportGridVisible(int index, BOOL state)`

### Parameters
- **index** (int) - The index of the viewport.
- **state** (BOOL) - TRUE to make the grid visible, FALSE to hide.
```

```APIDOC
## SetViewportLayout

### Description
Sets the layout of the viewports.

### Method
`SetViewportLayout(int layout)`

### Parameters
- **layout** (int) - The viewport layout identifier.
```

```APIDOC
## SetViewportMax

### Description
Maximizes or restores a viewport.

### Method
`SetViewportMax(BOOL max)`

### Parameters
- **max** (BOOL) - TRUE to maximize the viewport, FALSE to restore.
```

```APIDOC
## SetWhiteOrigin

### Description
Enables or disables the white origin setting.

### Method
`SetWhiteOrigin(BOOL b)`

### Parameters
- **b** (BOOL) - TRUE to enable white origin, FALSE to disable.
```

```APIDOC
## SetXRefAutoUpdateSuspended

### Description
Suspends or resumes automatic updates for XRefs.

### Method
`SetXRefAutoUpdateSuspended(BOOL onOff)`

### Parameters
- **onOff** (BOOL) - TRUE to suspend updates, FALSE to resume.
```

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

### Curve Start Point Management

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_n_u_r_b_s_cap_surface.html

Functions to set and get the start point of a curve at a specific time.

```APIDOC
## SetCurveStartPoint (TimeValue t, double startpoint)

### Description
Sets the start point of a curve at a given time.

### Method
SetCurveStartPoint

### Endpoint
SetCurveStartPoint(TimeValue t, double startpoint)

## GetCurveStartPoint (TimeValue t)

### Description
Retrieves the start point of a curve at a given time.

### Method
GetCurveStartPoint

### Endpoint
GetCurveStartPoint(TimeValue t)
```

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

### Get Interval Start Time

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interval.html

Returns the start time of the interval. This is a const method, meaning it does not modify the interval.

```cpp
134{ return start; }
```

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

### GWinSetup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_clear_anim_flag_enum_proc-members.html

Setup information for a graphics window.

```APIDOC
## GWinSetup

### Description
Contains setup parameters and configuration for a graphics window or viewport.

### Usage
Used to initialize or modify the properties of a viewport.
```

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

### SetUpDelegates

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_base_behavior-members.html

Sets up delegates for the behavior.

```APIDOC
## SetUpDelegates

### Description
Sets up delegates for the behavior.

### Method
`inline virtual`

### Parameters
- **participants** (*INodeTab &&*) - Description of the participants parameter.
```

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

### GetStart()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_snippet.html

Gets the start value of the Snippet.

```APIDOC
## GetStart()

### Description
Gets the start value of the Snippet.

### Method
int GetStart() const

### Endpoint
N/A (Class method)

### Parameters
None

### Request Example
N/A

### Response
*   **Return Value** (int) - The start value.
```

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

### getBkgStartTime

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_obj_param-members.html

Gets the background start time.

```APIDOC
## getBkgStartTime

### Description
Gets the start time for the background animation.
```

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

### Curve Start Point and Road-like Settings

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_n_u_r_b_s1_rail_sweep_surface.html

Functions to set and get the start point of a curve and control road-like behavior.

```APIDOC
## SetCurveStartPoint(TimeValue t, int pnum, double startpoint)

### Description
Sets the start point for a specific curve at a given time.

### Method
SetCurveStartPoint

### Parameters
#### Path Parameters
- **t** (TimeValue) - Description for t
- **pnum** (int) - Description for pnum
- **startpoint** (double) - Description for startpoint

## GetCurveStartPoint(TimeValue t, int pnum)

### Description
Gets the start point for a specific curve at a given time.

### Method
GetCurveStartPoint

### Parameters
#### Path Parameters
- **t** (TimeValue) - Description for t
- **pnum** (int) - Description for pnum

### Returns
- **double** - The start point of the curve.

## SetRoadlike(BOOL roadlike)

### Description
Sets whether the surface should behave like a road.

### Method
SetRoadlike

### Parameters
#### Path Parameters
- **roadlike** (BOOL) - Description for roadlike

## GetRoadlike()

### Description
Gets the road-like behavior status of the surface.

### Method
GetRoadlike

### Returns
- **BOOL** - The road-like status.
```

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

### getStart

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_g.html

Retrieves the start information via a callback.

```APIDOC
## getStart()

### Description
Retrieves the start information via a callback.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None

### Response
- **return value** (SpaceArrayCallback) - The SpaceArrayCallback object.
```

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

### PreDeformSetup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_p.html

Handles setup before deformation. Returns a GizmoClass object.

```APIDOC
## PreDeformSetup()

### Description
Performs setup operations before a deformation.

### Method
PreDeformSetup()

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

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **GizmoClass**: The GizmoClass object.
```

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

### Accessing IMeshSelect Interface Example

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_mesh_select.html

Example of how a plug-in developer can use the GetMeshSelectInterface macro to get a pointer to the IMeshSelect interface.

```cpp
IMeshSelect *ims = GetMeshSelectInterface(anim);
```

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

### Spring Controller Rolling Start

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface15.html

Methods to set and get the rolling start value for the quick manipulation mode of spring controllers.

```APIDOC
## SetSpringRollingStart

### Description
Sets the rolling start value of the quick manipulation mode for spring controllers.

### Method
SET

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

### Parameters
- **in_start** (int) - Required - The desired rolling start value.
```

```APIDOC
## GetSpringRollingStart

### Description
Returns the rolling start value of the quick manipulation mode for spring controllers.

### Method
GET

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

### Parameters
None

### Response
- **int**: The current rolling start value.
```

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

### setup_key_access()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_m_a_x_key.html

Sets up key access for MAXKey.

```APIDOC
## setup_key_access()
ScripterExport IKey * setup_key_access  | ( | AnyKey & | _ak_ ,   
---|---|---
|  | IKeyControl ** | _kip_ )
```

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

### Spring Controller Rolling Start

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface13.html

Functions to set and get the rolling start value for spring controllers in quick manipulation mode.

```APIDOC
## SetSpringRollingStart

### Description
Sets the rolling start value of the quick manipulation mode for spring controllers.

### Method
`virtual void SetSpringRollingStart (int in_start)=0`

## GetSpringRollingStart

### Description
Returns the rolling start value of the quick manipulation mode for spring controllers.

### Method
`virtual int GetSpringRollingStart () const =0`
```

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

### PostDeformSetup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_p.html

Handles setup after deformation. Returns a GizmoClass object.

```APIDOC
## PostDeformSetup()

### Description
Performs setup operations after a deformation.

### Method
PostDeformSetup()

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

### Parameters
None

### Request Example
N/A

### Response
#### Success Response
- **GizmoClass**: The GizmoClass object.
```

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

### Collectable::setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_static_interface_method.html

Sets up the garbage collection system.

```APIDOC
## Collectable::setup()

### Description
This static method initializes or configures the garbage collection system with a specified heap size.

### Signature
`static void setup (size_t)`

### Parameters
*   `size_t` - The size to set up for the heap.
```

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

### GetSimStartVelocity()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_delegate.html

Gets the delegate's velocity at the start of a simulation for a given node and start time. Useful for ensuring behavior repeatability.

```APIDOC
## GetSimStartVelocity()

### Description
Gets the delegate's velocity at the start of a simulation. If the node is a delegate and the start time is the simulation start time, this will return the initial velocity of the delegate, exactly as the Crowd system computes it. This function is particularly useful to call from within a behavior's InitBeforeSim function, in order to make sure the behavior is perfectly repeatable.

### Parameters
- **n** (INode *) - The node that the velocity is to be calculated for.
- **StartTime** (TimeValue) - The time to retrieve the value.

### Returns
The velocity of the node at a given start time.
```

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

### GetCurveStartPoint

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_g.html

Gets the starting point of a NURBS curve or surface.

```APIDOC
## GetCurveStartPoint()

### Description
Retrieves the starting point of a NURBS curve or surface.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
None

### Request Example
```
// No request body for this function
```

### Response
#### Success Response
- **Return Type**: NURBS1RailSweepSurface, NURBS2RailSweepSurface, NURBSBlendSurface, NURBSCapSurface, NURBSExtrudeSurface, NURBSLatheSurface, NURBSRuledSurface, NURBSULoftSurface - Various NURBS surface types.
```

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

### Setup Environment

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_number.html

Initializes or sets up the necessary environment for Number class operations. This is a static function that requires no arguments.

```cpp
static void | setup ()
```

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

### TwistHStartAngle()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_t.html

Gets the start angle for a twist constraint in IK.

```APIDOC
## TwistHStartAngle()

### Description
Retrieves the start angle value for a twist constraint applied to an IK chain or spline goal.

### Method
float

### Endpoint
N/A (Method Signature)

### Parameters
None

### Response
The start angle of the twist constraint.
```

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

### Start Parameter Wiring UI

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_param_wire_mgr.html

Launches the parameter wiring UI mode. Use this to initiate the visual interface for setting up parameter connections.

```cpp
virtual void StartParamWire ();
```

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

### complete_init

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_c.html

Completes initialization.

```APIDOC
## complete_init()

### Description
Completes initialization.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
#### Success Response
- **Return Type**: MAXClass, MAXSuperClass
```

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

### GetCurveStartPoint

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_n_u_r_b_s1_rail_sweep_surface.html

Gets the start point of the curves in the sweep surface.

```APIDOC
## GetCurveStartPoint

### Description
Gets the start point of the curves in the sweep surface.

### Member Function Documentation
GetCurveStartPoint
```

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

### Start

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_g_u_p.html

Called at boot time for plug-in initialization. The plug-in can decide to remain loaded or be discarded, or even cause 3ds Max to abort.

```APIDOC
## Start()

### Description
This method is called at boot time. At that point the plug-in should do its initialization and decide if it wants to remain loaded or if it can be discarded. As an option, it is also possible for a GUP plug-in for make 3ds Max fail and abort all together.

### Returns
- DWORD - One of the following values:
  - **GUPRESULT_KEEP**: Return this to have the plug-in remain loaded.
  - **GUPRESULT_NOKEEP**: Return this value to discard.
  - **GUPRESULT_ABORT**: Return this value to cause 3ds Max to shut down.

### Remarks
If a plug-in wishes to remain loaded (after returning a **GUPRESULT_KEEP** result code), it should start a new thread for its code as there is no other call from 3ds Max.
```

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

### GetStart

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_batch_render_view.html

Gets the start frame for the batch render view.

```APIDOC
## GetStart()

### Description
Gets the start frame for the batch render view.

### Returns
The start frame number.
```

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

### GetLinkTime() - Get Start Time of a Link

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_link_ctrl.html

Returns the start time associated with the 'i-th' link. The parameter 'i' specifies which parent (link) to query.

```cpp
virtual TimeValue GetLinkTime (int i);
```

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

### GWinSetup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_g.html

Represents a GWin setup.

```APIDOC
## GWinSetup()

### Description
Represents a GWin setup.

### Method
(Not specified, likely a constructor or factory)

### Endpoint
(Not applicable)

### Parameters
(Not specified)

### Request Example
(Not specified)

### Response
#### Success Response
- GWinSetup (type) - Description of return value not specified
```

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

### GetTimeStart

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/group___i_m_x_s_particle_container.html

Gets the start time of the proceed interval for operator and test calls.

```APIDOC
## GetTimeStart

### Description
Gets the start of the proceed interval in the Init/Proceed/Release calls for operator and test.

### Method
`virtual TimeValue GetTimeStart () const =0`
```

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

### StartParam()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_k_sys_1_1_i_spline_i_k_goal.html

Pure virtual function to get the starting parameter value of the spline.

```APIDOC
## ◆ StartParam()
| virtual float StartParam  | ( | __| ) | const |
|---|---|---|---|
| pure virtual
```

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

### pathConfig_doProjectSetupStepsUsingDirectory

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/primitives_8inl.html

Performs project setup steps using a specified directory.

```APIDOC
## pathConfig_doProjectSetupStepsUsingDirectory

### Description
Performs project setup steps using a specified directory.

### Signature
def_struct_primitive(pathConfig_doProjectSetupStepsUsingDirectory, pathConfig, "doProjectSetupStepsUsingDirectory")
```

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

### GWinSetup Constructor

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_g_win_setup.html

Initializes a new instance of the GWinSetup class.

```APIDOC
## GWinSetup()

### Description
Constructs a GWinSetup object.

### Method
Constructor

### Parameters
None
```

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

### TwistHStartAngle()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_i_k_chain_control.html

Pure virtual function to get the starting angle for the Twist Handle.

```APIDOC
## virtual float TwistHStartAngle()

**Definition** iiksys.h:205

Pure virtual function to retrieve the starting angle of the Twist Handle.
```

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

### InitialCreation()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_i.html

Handles the initial creation process for gizmos.

```APIDOC
## InitialCreation()

### Description
Handles the initial creation process for gizmos.

### Method
N/A (Function Signature)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Associated Types
GizmoClass
```

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

### GetTimeToStartOverride

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_action_item_override_manager-members.html

Gets the time value at which the current action item override started.

```APIDOC
## GetTimeToStartOverride

### Description
Gets the time value at which the current action item override started.

### Method
virtual TimeValue GetTimeToStartOverride(void) const = 0

### Returns
The TimeValue when the override began.
```

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

### Get Node Material Example

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_node.html

Example demonstrating how to retrieve a node's material and create a dummy material if none is assigned. This ensures a valid material for rendering.

```cpp
// Get material for node
mtl = node->GetMtl();
if (!mtl) {
// Node has no material, create a dummy material based on wireframe color
// This is done so the renderer does not have to worry about nodes
// without materials. It will, in effect, assure that every node has
// a valid material.
mtl = new DumMtl( (Color)(node->GetWireColor()) );
DebugPrint(_T("\tCreated dummy material for: %s.\n"), node->GetName());
}
```

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

### GetRendStart

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface16-members.html

Initiates the rendering process.

```APIDOC
## GetRendStart()

### Description
Starts the rendering process.

### Method
`pure virtual`

### Interface
`Interface`
```

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

### PreDeformSetup()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_gizmo_class.html

Performs setup operations before the deformation process begins.

```APIDOC
## PreDeformSetup()

### Description
This method is called before the actual deformation loop to allow the plug-in to create any temporary data it may need.

### Parameters
- **TimeValue t**: The time of the modification.
```

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

### Get IPatchOps Interface and Start Command Mode

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_patch_ops.html

Obtain a pointer to the IPatchOps interface and start an interactive command mode. Ensure the Animatable object is valid before calling GetInterface.

```cpp
IPatchOps *ipo = (IPatchOps *)anim->GetInterface(I_PATCHOPS);
ipo->StartCommandMode(PcmAttach);
```

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

### Rotation and Name Settings

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_script.html

Functions for getting and setting the start rotation and name of the script.

```APIDOC
## float GetStartRot ()

### Description
Gets the starting rotation of the script.

### Method
GET

### Endpoint
/script/start/rotation

### Response
#### Success Response (200)
- **float** - The starting rotation value.

## void SetStartRot (float r)

### Description
Sets the starting rotation of the script.

### Method
PUT

### Endpoint
/script/start/rotation

### Parameters
#### Request Body
- **r** (float) - Required - The new starting rotation value.

## const MCHAR * GetName () const

### Description
Gets the name of the script.

### Method
GET

### Endpoint
/script/name

### Response
#### Success Response (200)
- **const MCHAR *** - Pointer to the script name.

## void SetName (const MCHAR *n)

### Description
Sets the name of the script.

### Method
PUT

### Endpoint
/script/name

### Parameters
#### Request Body
- **n** (const MCHAR *) - Required - The new name for the script.
```

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

### pathConfig_doProjectSetupSteps

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/primitives_8inl.html

Performs project setup steps.

```APIDOC
## pathConfig_doProjectSetupSteps

### Description
Performs project setup steps.

### Signature
def_struct_primitive(pathConfig_doProjectSetupSteps, pathConfig, "doProjectSetupSteps")
```

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

### Frame and Position Settings

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_script.html

Functions for getting and setting the start frame and position of the script.

```APIDOC
## int GetStartFrame ()

### Description
Gets the start frame of the script.

### Method
GET

### Endpoint
/script/start/frame

### Response
#### Success Response (200)
- **int** - The start frame number.

## void SetStartFrame (int f)

### Description
Sets the start frame of the script.

### Method
PUT

### Endpoint
/script/start/frame

### Parameters
#### Request Body
- **f** (int) - Required - The new start frame number.

## Point3 GetStartPos ()

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

### Method
GET

### Endpoint
/script/start/position

### Response
#### Success Response (200)
- **Point3** - The starting position (X, Y, Z coordinates).

## void SetStartPos (Point3 p)

### Description
Sets the starting position of the script.

### Method
PUT

### Endpoint
/script/start/position

### Parameters
#### Request Body
- **p** (Point3) - Required - The new starting position.
```

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

### setup_layout()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_rollout_control.html

Sets up the layout for the control. This is a virtual method.

```APIDOC
## setup_layout()

### Description
Sets up the layout for the control.

### Method
virtual ScripterExport void setup_layout(Rollout * _ro_, layout_data * _pos_, int & _current_y_)

### Parameters
*   **_ro_** (Rollout *) - Pointer to the rollout.
*   **_pos_** (layout_data *) - Pointer to layout data.
*   **_current_y_** (int &) - Reference to the current vertical position.
```

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

### GetStart

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/functions_func_g.html

Retrieves the start information from various objects.

```APIDOC
## GetStart()

### Description
Retrieves the start information from various objects.

### Method
Not applicable (function signature)

### Endpoint
Not applicable (function signature)

### Parameters
None

### Response
- **return value** (GenericHierarchy, IBatchRenderView, Snippet) - The object containing start information.
```

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

### StartJoint()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_k_sys_1_1_i_spline_i_k_goal.html

Pure virtual function to get the Start Joint node of the IK Chain.

```APIDOC
## ◆ StartJoint()
| virtual INode * StartJoint  | ( | __| ) | const |
|---|---|---|---|
| pure virtual |

Remarks:
    Get the Start Joint node of the IK Chain
```

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

### Init()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_osnap.html

Method to initialize the Osnap plug-in.

```APIDOC
## Init()

### Description
Method to initialize the Osnap plug-in.

### Syntax
```cpp
DllExport void Init();
```
```

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

### Get Particle Channel Event Start Write Interface

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/_i_particle_channel_event_start_8h.html

Macro to retrieve the write interface for Particle Channel Event Start. Requires an object with a GetInterface method and the PARTICLECHANNELEVENTSTARTW_INTERFACE ID.

```cpp
#define GetParticleChannelEventStartWInterface(obj) ((IParticleChannelPTVW*)obj->GetInterface(PARTICLECHANNELEVENTSTARTW_INTERFACE))
```

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

### Begin()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_k_sys_1_1_iter_joint.html

Starts the iteration over the joints in the LinkChain.

```APIDOC
## Begin()

| void Begin | ( | bool | _in_world_| ) |

### Description
Starts the iteration over the joints. The argument determines if the first pivot starts at (0,0,0) or at the LinkChain's parentMatrix.

### Parameters
*   **_in_world_** (bool) - If true, the first pivot starts at (0,0,0). If false, it starts at LinkChain::parentMatrix.
```

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

### Get Particle Channel Event Start Read Interface

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/_i_particle_channel_event_start_8h.html

Macro to retrieve the read-only interface for Particle Channel Event Start. Requires an object with a GetInterface method and the PARTICLECHANNELEVENTSTARTR_INTERFACE ID.

```cpp
#define GetParticleChannelEventStartRInterface(obj) ((IParticleChannelPTVR*)obj->GetInterface(PARTICLECHANNELEVENTSTARTR_INTERFACE))
```

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

### GizmoClass::PreDeformSetup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_gizmo_class-members.html

Performs setup operations before deformation.

```APIDOC
## PreDeformSetup GizmoClass::PreDeformSetup

### Description
Performs setup operations before deformation.

### Method
inlinevirtual

### Parameters
- **t** (TimeValue) - The time value at which to perform the setup.
```

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

### Rendering Time Settings

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface12.html

Functions to get and set the type, start, and end times for rendering.

```APIDOC
## Rendering Time Settings

### GetRendTimeType

Gets the current rendering time type.

- **Method**: `int GetRendTimeType()`

### SetRendTimeType

Sets the rendering time type.

- **Method**: `void SetRendTimeType(int type)`

### GetRendStart

Gets the start time for the rendering.

- **Method**: `TimeValue GetRendStart()`

### SetRendStart

Sets the start time for the rendering.

- **Method**: `void SetRendStart(TimeValue start)`

### GetRendEnd

Gets the end time for the rendering.

- **Method**: `TimeValue GetRendEnd()`

### SetRendEnd

Sets the end time for the rendering.

- **Method**: `void SetRendEnd(TimeValue end)`
```

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

### RootTrack

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_tree_view_ops.html

Gets or sets the root track for the tree view. This defines the starting point for hierarchical navigation.

```APIDOC
## RootTrack

### Description
Gets or sets the root track for the tree view. This defines the starting point for hierarchical navigation.

### Method
GET/SET

### Endpoint
N/A (SDK Method)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **track** (TYPE_REFTARG) - Required - The reference target representing the root track.
```

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

### GizmoClass::PostDeformSetup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_gizmo_class-members.html

Performs setup operations after deformation.

```APIDOC
## PostDeformSetup GizmoClass::PostDeformSetup

### Description
Performs setup operations after deformation.

### Method
inlinevirtual

### Parameters
- **t** (TimeValue) - The time value at which to perform the setup.
```

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

### Get Elapsed Frames

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_frame_range.html

Returns the number of elapsed frames from the start to the current frame. This is an inline function.

```cpp
inline 

Remarks
    Returns the elapsed time of this range.   
55{ return (current - start); }
```

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

### Collectable::setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_m_a_x_multi_pass_camera_effect.html

Sets up the garbage collection system with a specified size. This is a static function.

```APIDOC
## setup size_t

### Description
Static function to set up the garbage collection system.

### Method
static

### Parameters
* **size** (size_t) - The size for the garbage collection setup.
```

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

### Cut Operation Setup

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_e_poly_mod13.html

Initializes a 'Cut' operation, specifying the starting subobject, point, and normal vector.

```APIDOC
## EpModCut

### Description
Set up a Cut operation, starting at a specific subobject and at a specific point.

### Method
virtual void

### Signature
EpModCut(int startLevel, int startIndex, Point3 startPoint, Point3 normal, INode *pNode=NULL)
```

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

### StartNewCreation

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_create_mouse_call_back-members.html

Starts a new creation process. This method is inline virtual.

```APIDOC
## StartNewCreation

### Description
Starts a new creation process. This method is inline virtual.

### Method
inlinevirtual
```

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

### SetupRendParams

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_interface16-members.html

Sets up rendering parameters.

```APIDOC
## SetupRendParams

### Description
Sets up the general rendering parameters.

### Method
`SetupRendParams(RendParams &rp, ViewExp *vpt, RendType t=RENDTYPE_NORMAL)`

### Parameters
* **rp** (RendParams &) - Reference to RendParams structure.
* **vpt** (ViewExp *) - Pointer to the ViewExp object.
* **t** (RendType, optional) - The type of rendering. Defaults to RENDTYPE_NORMAL.
```

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

### InitEEAxis

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_i_i_k_chain_control.html

Gets the axis from the start joint to the end joint (end-effector axis) at the initial (preferred angle) pose.

```APIDOC
## InitEEAxis()

### Description
Gets the axis from the start joint to the end joint (end-effector axis) at the initial (preferred angle) pose.

### Method
`virtual Point3 InitEEAxis(TimeValue time) = 0;`

### Parameters
- `time` (TimeValue): The time at which to get the initial end-effector axis.

### Remarks
Please refer to ChainNormal().
```

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

### BeginCreate()

Source: https://help.autodesk.com/cloudhelp/2026/ENU/MAXDEV-CPP-API-REF/class_data_class_desc.html

Handles the custom creation process of the plug-in object, allowing plug-ins to manage their own creation flow, potentially by pushing a command mode.

```APIDOC
## BeginCreate()

| virtual CoreExport int BeginCreate  | ( | Interface * | _i_| ) |

The custom creation process of the plug-in object is handled by this method. 
For example, a plug-in can create a custom command mode and push it on the command stack to handle the creation process.  
  
Important Note: A plug-in that doesn't want to participate in the standard object creation mechanism using CreateMouseCallBack must push a CommandMode on the stack in this method and remove it in EndCreate(). This is true even if the plug-in doesn't do anything inside the mode. A mode has to be pushed on the stack and then later popped off otherwise a crash will occur (if the default implementation of this method is not used). For more details on object creation see the Advanced Topics section ~{ Object Creation Methods }~. 

Parameters
     i| An interface pointer the plug-in may use to call functions in 3ds Max.   

Returns
    To use the default creation process (the system implementation for this method) return 0; Return nonzero if the plug-in implements this method.   
Reimplemented from ClassDesc.
```
Tokens:
Raw