Vexus Plugin \ MAX Script Reference

Vexus Helper

Previous Next

 

Overview

The following methods can be used to get or set properties for Vexus Helpers (VexusHelper).

 

 

Methods


<integer>Version()

Returns the plugin version as an integer. For example, a return value of 100 would mean version 1.00

 

 

<integer>SelectRenderer() <string>Name

Used to select the a render engine listed on the VexusHelper by using the string found in the name slot.

 

 

Properties


<vexushelper>.Size : float

Get/Set the display size of the the helper in the viewport.

 

 

<vexushelper>.Billboard : boolean

When this option is enabled the VexusHelper icon will face the camera. If the option is disabled, the icon will lie flat in the XY plane.

 

 

<vexushelper>.texmap01 : texturemap

<vexushelper>.texmap02 : texturemap

<vexushelper>.texmap03 : texturemap

<vexushelper>.texmap04 : texturemap

<vexushelper>.texmap05 : texturemap

<vexushelper>.texmap06 : texturemap

<vexushelper>.texmap07 : texturemap

<vexushelper>.texmap08 : texturemap

<vexushelper>.texmap09 : texturemap

<vexushelper>.texmap10 : texturemap

<vexushelper>.texmap11 : texturemap

<vexushelper>.texmap12 : texturemap

<vexushelper>.texmap13 : texturemap

<vexushelper>.texmap14 : texturemap

<vexushelper>.texmap15 : texturemap

<vexushelper>.texmap16 : texturemap

<vexushelper>.texmap17 : texturemap

<vexushelper>.texmap18 : texturemap

<vexushelper>.texmap19 : texturemap

<vexushelper>.texmap20 : texturemap

Stores a texture map as an instance or a copy. There are currently 20 slots available.

 

Example

Below is an example of how to assign a checkered texture map to the first slot.

$.texmap01 = checker name:"My Checker Map"

 

 

<vexushelper>.material01 : material

<vexushelper>.material02 : material

<vexushelper>.material03 : material

<vexushelper>.material04 : material

<vexushelper>.material05 : material

<vexushelper>.material06 : material

<vexushelper>.material07 : material

<vexushelper>.material08 : material

<vexushelper>.material09 : material

<vexushelper>.material10 : material

<vexushelper>.material11 : material

<vexushelper>.material12 : material

<vexushelper>.material13 : material

<vexushelper>.material14 : material

<vexushelper>.material15 : material

<vexushelper>.material16 : material

<vexushelper>.material17 : material

<vexushelper>.material18 : material

<vexushelper>.material19 : material

<vexushelper>.material20 : material

Stores a material as an instance or a copy. There are currently 20 slots available.

 

Example

Below is an example of how to assign a standard material to the first slot.

$.material01 = StandardMaterial name:"My Material"

 

 

<vexushelper>.rendererSelection : integer

Get/Set the render selection by using an integer.

 

 

<vexushelper>.renderer01 : maxObject

<vexushelper>.renderer02 : maxObject

<vexushelper>.renderer03 : maxObject

<vexushelper>.renderer04 : maxObject

<vexushelper>.renderer05 : maxObject

<vexushelper>.renderer06 : maxObject

<vexushelper>.renderer07 : maxObject

<vexushelper>.renderer08 : maxObject

<vexushelper>.renderer09 : maxObject

<vexushelper>.renderer10 : maxObject

Get/Set the render engine.

 

 

<vexushelper>.render01name : string

<vexushelper>.render02name : string

<vexushelper>.render03name : string

<vexushelper>.render04name : string

<vexushelper>.render05name : string

<vexushelper>.render06name : string

<vexushelper>.render07name : string

<vexushelper>.render08name : string

<vexushelper>.render09name : string

<vexushelper>.render10name : string

Get/Set the slot name for the renderer.

 

 

<vexushelper>.renderer_element_array01 : maxObject array

<vexushelper>.renderer_element_array02 : maxObject array

<vexushelper>.renderer_element_array03 : maxObject array

<vexushelper>.renderer_element_array04 : maxObject array

<vexushelper>.renderer_element_array05 : maxObject array

<vexushelper>.renderer_element_array06 : maxObject array

<vexushelper>.renderer_element_array07 : maxObject array

<vexushelper>.renderer_element_array08 : maxObject array

<vexushelper>.renderer_element_array09 : maxObject array

<vexushelper>.renderer_element_array10 : maxObject array

Get/Set the array of render elements.

 

Example

In the example below we demonstrate how to store a render engine, then assign a custom name and lastly set as the active renderer by using it's custom name.

$.renderer03 = copy renderers.current

$.render03name = "My Renderer"

$.SelectRenderer "My Renderer"

 

 

 


 

Copyright © 2019 Boomer Labs and JokerMartini

http://boomerlabs.com/vexus