Differences

This shows you the differences between two versions of the page.

--- brazil:scripting [2016/03/30]
+++ brazil:scripting [2020/08/14] (current)
@@ Line 1: / Line 1: @@
+====== Scripting methods for Brazil ======
+> **Note:** //See also [[developer:rdkrhinoscripting|Scripting methods for the RDK]]//
+To get a scripting object for Brazil, use the following code:
+   dim brazil
+   set brazil = Rhino.GetPlugInObject("Brazil for Rhino")
+Then use the Brazil object to access the functions below.
+=====Methods=====
+   DocumentParameter(strPath, varValue)
+Returns or modifies document parameter.
+> **Parameters:** //[strPath = Required. String. Full path to document paramter in XML tree//
+varValue = Optional. Variant. Use to set value.
+]
+> **Returns:** //[Variant which is the current value of the parameter.//
+NULL in error conditions.
+]
+   ObjectParameter(strObjectId, strPath, varValue)
+Returns or modifies object parameter.
+> **Parameters:** //[strObjectId = Required. String. Object identifier.//
+strPath = Required. String. Full path to object paramter in XML tree.
+varValue = Optional. Variant. Use to set value.
+]
+> **Returns:** //[Variant which is the current value of the parameter.//
+NULL in error conditions.
+]
+   LightParameter(strLightId ,strPath, varValue)
+Returns or modifies light parameter.
+> **Parameters:** //[strLightId = Required. String. Light identifier.//
+strPath = Required. String. Full path to light paramter in XML tree.
+varValue = Optional. Variant. Use to set value.
+]
+> **Returns:** //[Variant which is the current value of the parameter.//
+NULL in error conditions.
+]

McNeel Wiki

Site Tools

Differences

Page Tools