Class and Function Reference

This is the class and function reference of TLab. It is generated for version R1307a. Please remember TLab is in the early developer stage, meaning you can use it but many things are quite rough to use. Have fun!



[top]

module tlab


This package contains all TLab-specific modules

    module  docgen
    module  primitives
    module  selftest
    module  util
    class  B3Tspline
    class  B3sphere
    pythonQt  pythonEditor
    pythonQt  scene



[top]

module tlab.docgen


tlab.docgen is a documentation tool for tlab. It is needed because PythonQt
does not support the standard documentation style of Python.


    class  docgen

    function  create_class_documentation(class_object) 
    function  create_module_documentation(obj) 
    function  isPythonQtClass(o) 
    function  writedocu() 


[top]

class docgen

documentation generator for tlab

    method  __init__
    method  getTag
    method  toHTMLString
    method  write_basic_class_info
    method  write_basic_qt_slot_info
    method  write_python_class_info
    method  write_pythonqt_class_info


[top]

module tlab.primitives


Defines simples shapes using T-splines




    function  mesh(ifaces, jfaces, addtoscene) 
    function  unitcube(addtoscene) 
    function  unitsquare(addtoscene) 


[top]

module tlab.selftest


runs some small tests

    module  tlab
    class  QColor
    class  QVector3D

    function  solarsystem() 
    function  spherepulse() 
    function  tspline_combine_cube() 
    function  tspline_face() 


[top]

module tlab.util


Defines some useful functions

    module  collections
    module  inspect
    class  _Helper
    class  _SettingsDict
    class  inspectorTython

    function  cd(path) 
    function  clear() 
    function  doc_tython() 
    function  ls(path) 
    function  memory_used() 
    function  printhtml(html_text) 
    function  pwd() 
    function  pylint() 


[top]

Scene class

Stores all visible 3d objects

Class Methods:

void addObject(Base3dObject* object)
Rep3dBoundingBox boundingBox()
Base3dObject* load(QString filename)
QString objectsInfoString(bool verbose)
QString objectsInfoString()
void removeAllObjects()
void removeObject(int index)
void removeObject(const Base3dObject* object)
void screenShot(QString filename)
void update()
void wait()

Class Attributes:

tuple objects
SimpleUndoStack undoStack
ViewSystem views
Workbench workbench


[top]

Workbench class

None

Class Methods:

bool findPointOnWorkbench(QVector3D base, QVector3D direction, QVector3D& point, float& lambda)
bool findPointOnWorkbench(QVector3D base, QVector3D direction, QVector3D& point)

Class Attributes:

bool active
QVector3D center
QVector3D uDir
long uInc
SimpleUndoStack undoStack
QVector3D vDir
long vInc
bool visible


[top]

ViewSystem class

None

Class Methods:

void reset()

Class Attributes:

Camera activeCam
unicode infoString


[top]

B3Tspline class

None

Class Methods:

bool _addControlPoint(int vId, QVector3D cp, float weight)
bool _addControlPoint(int vId, QVector3D cp)
int _addControlPoint(float x, float y, float z, float w)
int _addControlPoint(float x, float y, float z)
int _addEdge(int vId1, int vId2, double len, int id)
int _addEdge(int vId1, int vId2, double len)
int _addEdge(int vId1, int vId2)
int _addFace(QList<int> vIds, QList<int> cornerVIds, int id)
int _addFace(QList<int> vIds, QList<int> cornerVIds)
int _addFace(QList<int> vIds)
int _addFace(int vId1, int vId2, int vId3, int vId4, int id)
int _addFace(int vId1, int vId2, int vId3, int vId4)
int _addVertex(int vId)
int _addVertex()
bool _appendOtherTSpline(const B3Tspline* other)
bool _extraordinarySubdivide()
bool _removeControlPoint(int vId)
bool _removeEdge(int eId)
bool _removeFace(int id)
bool _removeTjunctions()
bool _removeVertex(int vId)
float controlPointWeight(int cId)
QList getDirectFaceVertices(uint fId)
QString getEdgeInfo(int eId)
double getEdgeLength(int eId)
QString getFaceInfo(int fId)
QList getFacesAtEdge(int eId)
QList getMarkedVerticesFromFace(uint fId)
QString getObjectInfo()
int getVerbosityLevel()
QList getVertexFaceLoop(int fId)
QString getVertexInfo(int vId)
QList getVerticesAtEdge(int eId)
bool hasControlPoint(int vId)
bool isBoundaryEdge(int eId)
void move(QVector3D vec)
void move(double x, double y, double z)
bool setControlPoint(int id, QVector3D vec)
bool setControlPointWeight(int cId, float weight)
bool setVerbosityLevel(int level)
bool writeSTL(QString filename)
bool writeTOPEN(QString filename)

Class Attributes:

unicode baseInfoString
Rep3dBoundingBox boundingBox
QColor color
int degree
unicode extraInfoString
bool extraordinary
int group
int layer
bool meshVisible
bool modelVisible
unicode name
int numberOfControlPoints
int numberOfEdges
int numberOfFaces
int numberOfVertices
bool selected
unicode type
SimpleUndoStack undoStack
bool valid
bool visible


[top]

B3sphere class

None

Class Methods:

void move(QVector3D vec)
void move(double x, double y, double z)

Class Attributes:

unicode baseInfoString
Rep3dBoundingBox boundingBox
QVector3D center
QColor color
unicode extraInfoString
int group
int layer
bool meshVisible
bool modelVisible
unicode name
float radius
bool selected
unicode type
SimpleUndoStack undoStack
bool visible


generated on July 02, 2013 by TLdocgen version 0.04