Guide
Summary
A guide widget
Instance Properties
Name | Return Type | Description |
---|---|---|
index | number Read-only | The index of the active widget |
layer | Layer Read/Write | The layer the guide is on |
group | Group Read/Write | The group this guide is part of |
transform | Transform Read/Write | The transform of the Guide Widget |
position | Vector3 Read/Write | The 3D position of the Guide Widget |
rotation | Rotation Read/Write | The 3D orientation of the Guide Widget |
scale | number Read/Write | The scale of the Guide Widget |
Class Methods
Guide:NewCube(transform)
Creates a new cube guide with a default size using the transform for position and orientation
Returns: Guide (A new cube guide)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
transform | The transform of the Guide Widget |
Example
Guide:NewSphere(transform)
Creates a new sphere guide with a default size using the transform for position and orientation
Returns: Guide (A new sphere guide)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
transform | The transform of the Guide Widget |
Example
Guide:NewCapsule(transform)
Creates a new capsule guide with a default size using the transform for position and orientation
Returns: Guide (A new capsule guide)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
transform | The transform of the Guide Widget |
Example
Guide:NewCone(transform)
Creates a new cone guide with a default size using the transform for position and orientation
Returns: Guide (A new cone guide)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
transform | The transform of the Guide Widget |
Example
Guide:NewEllipsoid(transform)
Creates a new ellipsoid guide with a default size using the transform for position and orientation
Returns: Guide (A new ellipsoid guide)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
transform | The transform of the Guide Widget |
Example
Guide:NewCustom(transform, model)
Creates a new custom guide from a 3d model. Note that custom guides have to be convex so your model will be "wrapped" as a convex hull
Returns: Guide (A new custom guide based on the convex hull of the model)
Parameters:
Name | Type | Default | Description |
---|---|---|---|
transform | The transform of the Guide Widget | ||
model | The Model to use for the custom guide |
Example
Instance Methods
guide:Select()
Adds the guide to the current selection
Returns: nil
Example
guide:Deselect()
Removes the guide from the current selection
Returns: nil
Example
guide:Delete()
Deletes the guide
Returns: nil
Example
guide:Scale(scale)
Scales the guide (scale can be non-uniform as some guide types can be stretched)
Returns: nil
Parameters:
Name | Type | Default | Description |
---|---|---|---|
scale | The scale vector for scaling the Guide Widget |
Example
Last updated