HappyDoc Generated Documentation Class: OpenModels

. / _chimera / OpenModels 

Not instantiable from Python

constants:
  • ADDMODEL = addModel
  • CenterOfModels = 1
  • CenterOfView = 3
  • Default = -99
  • Fixed = 0
  • Independent = 2
  • OPENDONE = openDone
  • REMOVEMODEL = removeModel
attributes:
  • cofr: Point
  • cofrMethod: int
Methods   
  addRemoveHandler 
addRemoveHandler ( self )

arguments/return value unknown

Add trigger handler for removing models

  bsphere 
bsphere ( self )

bsphere() -> bool, Sphere

  deleteRemoveHandler 
deleteRemoveHandler ( self )

arguments/return value unknown

Delete trigger handler for removing models

  addAddHandler 
addAddHandler ( self )

arguments/return value unknown

Add trigger handler for adding models

  close 
close ( self )

arguments/return value unknown

Close models and remove from list of open models.

close(models) => None

  open 
open ( self )

arguments/return value unknown

Read in a file and add the models within.

open(filename, type=None, [add arguments,] args, *kw) -> [model(s)]

If the type is given, then then open handler for that type is used. Otherwise the filename suffix is examined to determine which open function to call. See the add documentation above.

  computeBounds 
computeBounds ( self )

computeBounds() -> bool, Sphere, BBox

  localXform 
localXform (
        self,
        id,
        xf,
        )

localXform(id: int, xf: Xform)

  setXform 
setXform ( self,  xform )

setXform(xform: Xform) setXform(id: int, xform: Xform)

  add 
add ( self )

arguments/return value unknown

Add models to the list of open models.

add(models, sameAs=None, hidden=False) => None

baseId is the base model id to start numbering models with.

sameAs is an existing model that all of the new models should share the same id and subid.

If shareXform is true, then initialize the model's transformation matrix to be the same as the lowest positively numbered model (if not baseId specified) or the lowest numbered model with the same baseId. (Using sameAs overrides shareXform).

If hidden is true, that means that the given models do not normally appear when listed.

  setActive 
setActive (
        self,
        id,
        active,
        )

setActive(id: int, active: bool)

  get 
get ( self )

get() -> OpenModels

  deleteAddHandler 
deleteAddHandler ( self )

arguments/return value unknown

Delete trigger handler for adding models

  listIds 
listIds (
        self,
        hidden,
        all,
        )

listIds(hidden: bool = false, all: bool = false) -> list of tuple(int, int)

  addOpenFinishedHandler 
addOpenFinishedHandler ( self )

arguments/return value unknown

Add trigger handler for when a model is finished opening

  bbox 
bbox ( self )

bbox() -> bool, BBox

  closeAllModels 
closeAllModels ( self )

arguments/return value unknown

  hasActiveModels 
hasActiveModels ( self )

hasActiveModels() -> bool

  list 
list ( self )

arguments/return value unknown

List models from the list of open models.

list(id = None, hidden=False, all=False, modelTypes=[]) => [models]

id is a model identifier (an integer). If hidden is true, then the hidden models are returned. If all is true, then both hidden and non-hidden models are returned. modelTypes is a list of model types (see the global list modelTypes) that restricts the types of the models returned.

  remove 
remove ( self )

arguments/return value unknown

Remove models from the list of open models.

remove(models) => None

  openState 
openState (
        self,
        id,
        subid,
        )

openState(id: int, subid: int) -> OpenState

  applyXform 
applyXform (
        self,
        xf,
        viewer,
        )

applyXform(xf: Xform, viewer: Viewer)

  delOpenFinishedHandler 
delOpenFinishedHandler ( self )

arguments/return value unknown

Delete trigger handler when model is finished opening

  globalXform 
globalXform (
        self,
        id,
        xf,
        )

globalXform(id: int, xf: Xform)


This document was automatically generated Thu Nov 09 13:33:31 2006 by HappyDoc version 3.0.a1