vcComponent

from vcScript import *

# note: some of the methods called via comp in this snippet are documented under vcNode

def OnRun():

  ## COMPONENT

  ## get the handle to a vcComponent object

  app = getApplication()

  comp = app.findComponent('MyConveyor') # access any component in the layout by name

  comp = getComponent()# typical way to access the owner component of the python script (preferred approach)

  ## BEHAVIOURS

  ## this is how you can create new behaviours in python

  cont = comp.createBehaviour(VC_ONEWAYPATH,'MainPath')

  cont = comp.createBehaviour(VC_COMPONENTCONTAINER,'MyCont')

  creator = comp.createBehaviour(VC_COMPONENTCREATOR,'MyCreator')

  ## this is how you can access the existing behaviours in the component (note: british english spelling)

  path = comp.findBehaviour('MainPath')# by name

  paths = comp.findBehavioursByType(VC_ONEWAYPATH) # by name (returns a list)

  path = paths[0] # access the first item in the list like this

  ## FEATURES

  ## this is how you can create new features in python

  transform = comp.RootFeature.createFeature(VC_TRANSFORM,'Trans')

  transform.Expression = 'Tx(200.0).Tz(400.0)'

  transform.Expression = 'Tx(%f).Tz(%f)' % (200.0, 400.0)# more pythonic way to do the same

  cylinder = transform.createFeature(VC_CYLINDER,'MyCylinder')

  cylinder.Height = str(500)

  ## this is how you can access the existing features

  block = comp.findFeature('Block') # find feature by name in the whole component

  root = comp.RootFeature # root feature exists for all nodes even if the component contains no geometry

  kids = root.Children # returns the list of all the direct children

  ## PARAMETERS i.e. properties

  ## this is how you can create new parameters

  radius_prop = comp.createProperty(VC_REAL, 'CylinderRadius')

  bool_prop = comp.createProperty(VC_BOOLEAN, 'ToggleThis')

  ## this is how you can access existing properties

  prop = comp.getProperty('CylinderRadius')

  prop.Value = 250.0

  # or

  comp.CylinderRadius = 250.0

  all_props = comp.Properties # list of all user defined properties in the component

  for p in all_props: # (Visible, PDFExportLevel and BackfaceMode -properties are also included)

    # loop the list and print name and value for each

    print p.Name, p.Value

  ## NODES i.e. links

  ## this is how you can create new links

  link1 = comp.createNode(VC_NODE, 'FirstLink')

  link1.OffsetExpression = 'Tz(200).Ry(45)'

  path = link1.getBehaviour('MainPath') # use get- instead of findBehaviour to search behs in specific node

  ## this is how you can access existing nodes

  link2 = comp.findNode('SecondLink')

  if link2:

    # test if a node named "SecondLink" exists

    print 'It is there! :) '

  else:

    print "It's missing! :( "

from vcScript import *

comp = getComponent()

comp.createProperty(VC_REAL, "SurfaceLength",1)

foo = comp.getProperty("SurfaceLength")

foo.MinValue = 100

foo.MaxValue = 1000

foo.Value = 800

from vcScript import

* app = getApplication()

comp = app.findComponent("component_name")

name = comp.Name

uri = "file:///C:\\Users\\[Username]\\Documents\\[ProductName]\\4.0\My Models\\" + name + ".vcm"

comp.incrementRevision()

comp.save(uri)

from vcScript import *

#when the simulation is paused

def OnStop():

  app = getApplication()

  for c in app.Components:

    if c.Container != None:

      print c.Name

      #prints the name of components in storage

from vcScript import *

app = getApplication()

shared = [c for c in app.Components if c.IsUnique == False]

for c in shared:

  #prints the same memory address

  print c.RootFeature