pyscript.groups.Group

Package pyscript :: Module groups :: Class Group

[show private | hide private]

Class Group

object --+            
         |            
     PsObj --+        
             |        
     AffineObj --+    
                 |    
              Area --+
                     |
                    Group

Known Subclasses:: Align, Assemble, Box, Box_1, Boxed, Boxed, BSBox, BSLine, Capacitor, Circled, Circled, CodeBox, ColumnBox, Detector, Detector, Eps, FreeSpace, Gate, Gate, LambdaPlate, Laser, Lens, Meter, Mirror, Modulator, NoWire, Page, Pages, PhaseShifter, Resistor, TeXArea, TeXBox

Groups together a list of objects

Method Summary
	`__init__(self, objects, *options)` Initialisation of Group object
	`__getitem__(self, i)` Get an item from the list of objects
	`__getslice__(self, i, j)` Get a slice of items from the list of objects
	`__len__(self)` Returns the length of the object list
	`append(self, objs, *options)` append object(s) to group
self	`apply(self, **options)` apply attributes to all objects
Bbox	`bbox(self)` Gather together common bounding box for group Don't use Area's bbox as transformations may mean a tighter bbox (eg a circle)
	`body(self)` Returns the body postscript of the object
	`clear(self)` Clear all the elements and reset group to an empty group
	`insert(self, idx, obj)` insert object
	`recalc_size(self)` recalculate internal container size based on objects within
	`reverse(self)` Reverse the order of objects in the list of objects in the group
	`validate(self, obj)` make sure this object can be inserted into group
Inherited from AffineObj
self	`concat(self, t, p)` concat matrix t to tranformation matrix
P	`etoi(self, p_e)` convert external to internal co-ords
P	`itoe(self, p_i)` convert internal to external co-ords
self	`move(self, *args)` translate object by a certain amount
string	`postbody(self)` undo coordinate system transformation
string	`prebody(self)` set up transformation of coordinate system
self	`reflect(self, angle, p)` reflect object in mirror
self	`rotate(self, angle, p)` rotate object, the rotation is around p when supplied otherwise it's the objects origin
self	`scale(self, sx, sy, p)` scale object size (towards objects origin or p)
self	`shear(self, s, angle, p)` shear object
Inherited from PsObj
self	`__call__(self, **options)` Set a whole lot of attributes in one go
string	`__repr__(self)` Return a representation of this object
string	`__str__(self)` return actual postscript string to generate object
self	`copy(self, **options)` return a copy of this object with listed attributes modified
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
Inherited from type
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T

Property Summary
Inherited from Area
	`c`
	`e`
	`n`
	`ne`
	`nw`
	`s`
	`se`
	`sw`
	`w`

Class Variable Summary
Inherited from Area
	`c` = `pyscript.objects.Area.c`
`int`	`height`: the height
`P`	`isw` = `<class 'pyscript.vectors.P'>`
`int`	`width`: the width
Inherited from AffineObj
`P`	`o` = `<class 'pyscript.vectors.P'>`
`Matrix`	`T` = `<pyscript.vectors.Matrix instance at 0x40449cec>`

Method Details

init(self, *objects, **options)
(Constructor)

Initialisation of Group object

Parameters:: objects - list of objects to group together
(type=list); options - dictionary of options
(type=dict)

Overrides:: pyscript.base.PsObj.__init__

getitem(self, i)
(Indexing operator)

Get an item from the list of objects

Parameters:: i - the index of the item to get
(type=int)

getslice(self, i, j)
(Slicling operator)

Get a slice of items from the list of objects

Parameters:: i - the first index of the slice of items to get
(type=int); j - the last index of the slice of items to get
(type=int)

len(self)
(Length operator)

Returns the length of the object list

append(self, *objs, **options)

append object(s) to group

Parameters:: objs - list of objects to append
(type=list); options - dictionary of options
(type=dict)

apply(self, **options)

apply attributes to all objects

Parameters:: options - dictionary of attributes
(type=dict)

Returns:: reference to self
(type=self)

bbox(self)

Gather together common bounding box for group Don't use Area's bbox as transformations may mean a tighter bbox (eg a circle)

Returns:: a Bbox()
(type=Bbox)

Overrides:: pyscript.objects.Area.bbox

body(self)

Returns the body postscript of the object

Overrides:: pyscript.base.PsObj.body

clear(self)

Clear all the elements and reset group to an empty group

insert(self, idx, obj)

insert object

Parameters:: idx - index at which to insert object
(type=int); obj - the object to insert
(type=object)

recalc_size(self)

recalculate internal container size based on objects within

reverse(self)

Reverse the order of objects in the list of objects in the group

validate(self, obj)

make sure this object can be inserted into group

Parameters:: obj - object to test for insertability
(type=object)

Generated by Epydoc 2.0 on Mon Apr 24 17:02:37 2006

http://epydoc.sf.net