OpenStructure
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Namespaces | Data Structures | Typedefs | Enumerations | Functions | Variables
ost::gfx Namespace Reference

Namespaces

 detail
 
 impl
 
 map_iso
 
 py_gfx_obj
 
 RenderMode
 

Data Structures

struct  Bitmap
 
class  ColladaExporter
 
class  Color
 
class  BasicGradientColorOp
 
class  ByChainColorOp
 
class  ByElementColorOp
 
class  ColorOp
 
class  EntityViewColorOp
 
class  GradientColorOp
 
class  GradientLevelColorOp
 
class  MapHandleColorOp
 
class  UniformColorOp
 
class  Entity
 
class  Exporter
 
class  GfxNode
 
class  GfxNodeVisitor
 
class  GfxObj
 
class  GfxObjBase
 
struct  SpherePrim
 
struct  CylinderPrim
 
struct  TextPrim
 
class  GfxTestObj
 
class  GLWinBase
 
class  GostExporter
 
class  Gradient
 
class  GradientManager
 
class  InputEvent
 
class  MapIso
 
class  MapSlab
 
class  Material
 
class  PovState
 
class  PrimList
 
class  Primitive
 
class  Cuboid
 
class  Quad
 
class  CartoonRenderOptions
 
class  CPKRenderOptions
 
class  CustomRenderOptions
 
class  LineRenderOptions
 
class  LineTraceRenderOptions
 
class  RenderOptions
 
class  SimpleRenderOptions
 
class  SlineRenderOptions
 
class  TraceRenderOptions
 
struct  Viewport
 
class  Scene
 
class  SceneObserver
 
class  Selection
 
class  Shader
 
class  Surface
 
class  SymmetryOp
 
class  SymmetryNode
 
class  Texture
 
class  IndexedVertexArray
 
class  GfxNodeListAttrProxy
 
class  GfxNodeListProxy
 

Typedefs

typedef unsigned char ColorMask
 
typedef boost::shared_ptr
< UniformColorOp
UniformColorOpP
 
typedef std::vector
< RenderMode::Type
RenderModeTypes
 
typedef boost::shared_ptr< EntityEntityP
 
typedef boost::weak_ptr< EntityEntityW
 
typedef std::vector< GfxNodePGfxNodeVector
 
typedef boost::shared_ptr
< GfxNode
GfxNodeP
 
typedef std::vector< GfxNodePNodePtrList
 
typedef boost::shared_ptr
< GfxObjBase
GfxObjBaseP
 
typedef boost::shared_ptr< GfxObjGfxObjP
 
typedef std::vector< SpherePrimSpherePrimList
 
typedef std::vector< CylinderPrimCylinderPrimList
 
typedef std::vector< TextPrimTextPrimList
 
typedef boost::shared_ptr< MapIsoMapIsoP
 
typedef boost::shared_ptr
< MapSlab
MapSlabP
 
typedef boost::shared_ptr
< CartoonRenderOptions
CartoonRenderOptionsPtr
 
typedef boost::shared_ptr
< CPKRenderOptions
CPKRenderOptionsPtr
 
typedef boost::shared_ptr
< CustomRenderOptions
CustomRenderOptionsPtr
 
typedef boost::shared_ptr
< LineRenderOptions
LineRenderOptionsPtr
 
typedef boost::shared_ptr
< LineTraceRenderOptions
LineTraceRenderOptionsPtr
 
typedef boost::shared_ptr
< RenderOptions
RenderOptionsPtr
 
typedef boost::shared_ptr
< SimpleRenderOptions
SimpleRenderOptionsPtr
 
typedef boost::shared_ptr
< SlineRenderOptions
SlineRenderOptionsPtr
 
typedef boost::shared_ptr
< TraceRenderOptions
TraceRenderOptionsPtr
 
typedef std::vector
< SceneObserver * > 
SceneObserverList
 
typedef boost::shared_ptr
< Surface
SurfaceP
 
typedef std::vector< SymmetryOpSymmetryOpList
 
typedef unsigned int VertexID
 
typedef unsigned int LineID
 
typedef unsigned int TriID
 
typedef unsigned int QuadID
 

Enumerations

enum  ColorBit { DETAIL_COLOR = 1, MAIN_COLOR = 2 }
 
enum  InputDevice { INPUT_DEVICE_DUMMY =0, INPUT_DEVICE_MOUSE }
 
enum  InputCommand {
  INPUT_COMMAND_NONE =0, INPUT_COMMAND_ROTX, INPUT_COMMAND_ROTY, INPUT_COMMAND_ROTZ,
  INPUT_COMMAND_TRANSX, INPUT_COMMAND_TRANSY, INPUT_COMMAND_TRANSZ, INPUT_COMMAND_SLABN,
  INPUT_COMMAND_SLABF, INPUT_COMMAND_AUTOSLAB, INPUT_COMMAND_TOGGLE_FOG, INPUT_COMMAND_CUSTOM1,
  INPUT_COMMAND_CUSTOM2, INPUT_COMMAND_CUSTOM3, INPUT_COMMAND_REBUILD
}
 
enum  TransformTarget {
  TRANSFORM_VIEW =0, TRANSFORM_RIGID, TRANSFORM_TORSION, TRANSFORM_ANGLE,
  TRANSFORM_ROTAMER
}
 
enum  MapIsoType { ORIGINAL_MAP, DOWNSAMPLED_MAP }
 
enum  RenderPass {
  STANDARD_RENDER_PASS, GLOW_RENDER_PASS, DEPTH_RENDER_PASS, TRANSPARENT_RENDER_PASS,
  OVERLAY_RENDER_PASS
}
 

Functions

void DLLEXPORT_OST_GFX ExportBitmap (const String &fname, std::string ext, unsigned int width, unsigned int height, unsigned char *data)
 
Bitmap DLLEXPORT_OST_GFX ImportBitmap (const String &fname, std::string ext="")
 
Color DLLEXPORT_OST_GFX RGB (float r, float g, float b)
 
Color DLLEXPORT_OST_GFX RGBb (uchar r, uchar g, uchar b)
 
Color DLLEXPORT_OST_GFX RGBi (unsigned int r, unsigned int g, unsigned int b)
 
Color DLLEXPORT_OST_GFX RGBA (float r, float g, float b, float a)
 
Color DLLEXPORT_OST_GFX RGBAb (uchar r, uchar g, uchar b, uchar a)
 
Color DLLEXPORT_OST_GFX RGBAi (unsigned int r, unsigned int g, unsigned int b, unsigned int a)
 
Color DLLEXPORT_OST_GFX HSV (float h, float s, float v)
 
Color DLLEXPORT_OST_GFX HSVi (int h, int s, int v)
 
Color DLLEXPORT_OST_GFX HSVA (float h, float s, float v, float a)
 
Color DLLEXPORT_OST_GFX HSVAi (int h, int s, int v, int a)
 
DLLEXPORT_OST_GFX std::ostream & operator<< (std::ostream &, const Color &c)
 
def Stereo
 
def FitToScreen
 
def GostExporter
 
def ColladaExporter
 

Variables

static const unsigned int VA_SPHERE_MAX_DETAIL =12
 
static const unsigned int VA_ICO_SPHERE_MAX_DETAIL =4
 
static const unsigned int VA_CYL_MAX_DETAIL =12
 
tuple WHITE = RGB(1.0,1.0,1.0)
 
tuple BLACK = RGB(0.0,0.0,0.0)
 
tuple GREY = RGB(0.5,0.5,0.5)
 
tuple RED = RGB(1.0,0.0,0.0)
 
tuple DARKRED = RGB(0.5,0.0,0.0)
 
tuple LIGHTRED = RGB(1.0,0.5,0.5)
 
tuple GREEN = RGB(0.0,1.0,0.0)
 
tuple DARKGREEN = RGB(0.0,0.5,0.0)
 
tuple LIGHTGREEN = RGB(0.5,1.0,0.5)
 
tuple BLUE = RGB(0.0,0.0,1.0)
 
tuple DARKBLUE = RGB(0.0,0.0,0.5)
 
tuple LIGHTBLUE = RGB(0.5,0.5,1.0)
 
tuple YELLOW = RGB(1.0,1.0,0.0)
 
tuple DARKYELLOW = RGB(0.5,0.5,0.0)
 
tuple LIGHTYELLOW = RGB(1.0,1.0,0.5)
 
tuple CYAN = RGB(0.0,1.0,1.0)
 
tuple DARKCYAN = RGB(0.0,0.5,0.5)
 
tuple LIGHTCYAN = RGB(0.5,1.0,1.0)
 
tuple MAGENTA = RGB(1.0,0.0,1.0)
 
tuple DARKMAGENTA = RGB(0.5,0.0,0.5)
 
tuple LIGHTMAGENTA = RGB(1.0,0.5,1.0)
 
 PURPLE = MAGENTA
 
 DARKPURPLE = DARKMAGENTA
 
 LIGHTPURPLE = LIGHTMAGENTA
 
tuple ORANGE = RGB(1.0,0.5,0.0)
 
tuple DARKORANGE = RGB(0.5,0.25,0.0)
 
tuple LIGHTORANGE = RGB(1.0,0.75,0.5)
 

Typedef Documentation

typedef boost::shared_ptr<CartoonRenderOptions> CartoonRenderOptionsPtr

Definition at line 137 of file cartoon_render_options.hh.

typedef unsigned char ColorMask

Definition at line 43 of file color_op.hh.

typedef boost::shared_ptr<CPKRenderOptions> CPKRenderOptionsPtr

Definition at line 62 of file cpk_render_options.hh.

typedef boost::shared_ptr<CustomRenderOptions> CustomRenderOptionsPtr

Definition at line 62 of file custom_render_options.hh.

typedef std::vector<CylinderPrim> CylinderPrimList

Definition at line 105 of file gfx_prim.hh.

typedef boost::shared_ptr<Entity> EntityP

Definition at line 27 of file entity_fw.hh.

typedef boost::weak_ptr<Entity> EntityW

Definition at line 29 of file entity_fw.hh.

typedef boost::shared_ptr<GfxNode> GfxNodeP

Definition at line 31 of file gfx_node_fw.hh.

typedef std::vector<GfxNodeP> GfxNodeVector

Definition at line 41 of file gfx_node.hh.

typedef boost::shared_ptr<GfxObjBase> GfxObjBaseP

Definition at line 30 of file gfx_object_fw.hh.

typedef boost::shared_ptr<GfxObj> GfxObjP

Definition at line 32 of file gfx_object_fw.hh.

typedef unsigned int LineID

Definition at line 47 of file vertex_array.hh.

typedef boost::shared_ptr<LineRenderOptions> LineRenderOptionsPtr

Definition at line 53 of file line_render_options.hh.

Definition at line 43 of file line_trace_render_options.hh.

typedef boost::shared_ptr<MapIso> MapIsoP

Definition at line 43 of file map_iso.hh.

typedef boost::shared_ptr<MapSlab> MapSlabP

Definition at line 38 of file map_slab.hh.

typedef std::vector<GfxNodeP> NodePtrList

Definition at line 34 of file gfx_node_fw.hh.

typedef unsigned int QuadID

Definition at line 49 of file vertex_array.hh.

typedef std::vector<RenderMode::Type> RenderModeTypes

Definition at line 50 of file entity.hh.

typedef boost::shared_ptr<RenderOptions> RenderOptionsPtr

Definition at line 37 of file render_options.hh.

typedef std::vector<SceneObserver*> SceneObserverList

Definition at line 51 of file scene.hh.

typedef boost::shared_ptr<SimpleRenderOptions> SimpleRenderOptionsPtr

Definition at line 59 of file simple_render_options.hh.

typedef boost::shared_ptr<SlineRenderOptions> SlineRenderOptionsPtr

Definition at line 50 of file sline_render_options.hh.

typedef std::vector<SpherePrim> SpherePrimList

Definition at line 47 of file gfx_prim.hh.

typedef boost::shared_ptr<Surface> SurfaceP

Definition at line 43 of file surface.hh.

typedef std::vector<SymmetryOp> SymmetryOpList

Definition at line 45 of file symmetry_node.hh.

typedef std::vector<TextPrim> TextPrimList

Definition at line 117 of file gfx_prim.hh.

typedef boost::shared_ptr<TraceRenderOptions> TraceRenderOptionsPtr

Definition at line 60 of file trace_render_options.hh.

typedef unsigned int TriID

Definition at line 48 of file vertex_array.hh.

typedef boost::shared_ptr<UniformColorOp> UniformColorOpP

Definition at line 57 of file uniform_color_op.hh.

typedef unsigned int VertexID

Definition at line 46 of file vertex_array.hh.

Enumeration Type Documentation

enum ColorBit
Enumerator
DETAIL_COLOR 
MAIN_COLOR 

Definition at line 38 of file color_op.hh.

Enumerator
INPUT_COMMAND_NONE 
INPUT_COMMAND_ROTX 
INPUT_COMMAND_ROTY 
INPUT_COMMAND_ROTZ 
INPUT_COMMAND_TRANSX 
INPUT_COMMAND_TRANSY 
INPUT_COMMAND_TRANSZ 
INPUT_COMMAND_SLABN 
INPUT_COMMAND_SLABF 
INPUT_COMMAND_AUTOSLAB 
INPUT_COMMAND_TOGGLE_FOG 
INPUT_COMMAND_CUSTOM1 
INPUT_COMMAND_CUSTOM2 
INPUT_COMMAND_CUSTOM3 
INPUT_COMMAND_REBUILD 

Definition at line 39 of file input.hh.

Enumerator
INPUT_DEVICE_DUMMY 
INPUT_DEVICE_MOUSE 

Definition at line 34 of file input.hh.

enum MapIsoType
Enumerator
ORIGINAL_MAP 
DOWNSAMPLED_MAP 

Definition at line 38 of file map_iso.hh.

enum RenderPass
Enumerator
STANDARD_RENDER_PASS 

shaded and textured renderpass, intended to be shown directly to the user

GLOW_RENDER_PASS 

only renders "glowing" parts objects

DEPTH_RENDER_PASS 

renders objects with solid color as used for shadow map generation

TRANSPARENT_RENDER_PASS 

\ brief for transparent objects the standard render pass is not supposed to render transparent objects, as they should get drawn after the rest of the scene

OVERLAY_RENDER_PASS 

Definition at line 27 of file render_pass.hh.

Enumerator
TRANSFORM_VIEW 
TRANSFORM_RIGID 
TRANSFORM_TORSION 
TRANSFORM_ANGLE 
TRANSFORM_ROTAMER 

Definition at line 57 of file input.hh.

Function Documentation

def ost.gfx.ColladaExporter (   file,
  scale = 1.0,
  to_origin = True 
)

Definition at line 407 of file __init__.py.

void DLLEXPORT_OST_GFX ost::gfx::ExportBitmap ( const String fname,
std::string  ext,
unsigned int  width,
unsigned int  height,
unsigned char *  data 
)
def ost.gfx.FitToScreen (   gfx_ent,
  width = None,
  height = None,
  margin = 0.05 
)
Setup camera such that it is centered on the graphical entity and the entity 
fits the entire viewport. The longest axes of the entity are aligned along 
the x- and y- axes of the screen.

:param gfx_ent: The graphical entity
:type gfx_ent: str or :class:`Entity`

Definition at line 69 of file __init__.py.

def ost.gfx.GostExporter (   file,
  scale = 1.0,
  to_origin = True 
)

Definition at line 401 of file __init__.py.

Color DLLEXPORT_OST_GFX ost::gfx::HSV ( float  h,
float  s,
float  v 
)

HSV color spec from floats.

h: Hue from 0 to 1 (0=red, 2/6=green, 4/6=blue) outside values are modulus 1, not clamped s: Saturation from 0 (no color) to 1 (full color) outside values are clamped v: Value from 0 (no light, black) to 1 (full light) outside values are clamped

out-of-bounds values are perfectly fine, as they are sometimes needed in hsv gradients, e.g.

g1=gfx.Gradient([gfx.HSV(-60.0/360.0,1,1),gfx.HSV(60.0/360.0,1,1)]) g1.hsv_mode=True g2=gfx.Gradient([gfx.HSV(300.0/360.0,1,1),gfx.HSV(420.0/360.0,1,1)]) g2.hsv_mode=True

both will blend from purple to yellow via red

Color DLLEXPORT_OST_GFX ost::gfx::HSVA ( float  h,
float  s,
float  v,
float  a 
)

HSVA color spec from floats.

see HSV(float,float,float); alpha from 0 to 1

Color DLLEXPORT_OST_GFX ost::gfx::HSVAi ( int  h,
int  s,
int  v,
int  a 
)

HSVA color spec from integers.

see HSVi(int, int, int); alpha from 0 to 100

Color DLLEXPORT_OST_GFX ost::gfx::HSVi ( int  h,
int  s,
int  v 
)

HSV color spec from integers.

h: Hue from 0 to 359 (0=red, 120=green, 240=blue) outside values are modulus 360, not clamped s: Saturation from 0 (no color) to 100 (full color) outside values are clamped v: Value from 0 (no light, black) to 100 (full light) outside values are clamped

signed integers on purpose, allows negative values to be used for hsv gradients, see comments for HSV(float,float,float)

Bitmap DLLEXPORT_OST_GFX ost::gfx::ImportBitmap ( const String fname,
std::string  ext = "" 
)
DLLEXPORT_OST_GFX std::ostream& ost::gfx::operator<< ( std::ostream &  ,
const Color &  c 
)

string form

Color DLLEXPORT_OST_GFX ost::gfx::RGB ( float  r,
float  g,
float  b 
)

RGB color spec from floats (0.0-1.0)

Color DLLEXPORT_OST_GFX ost::gfx::RGBA ( float  r,
float  g,
float  b,
float  a 
)

RGBA color spec from floats (0.0-1.0)

Color DLLEXPORT_OST_GFX ost::gfx::RGBAb ( uchar  r,
uchar  g,
uchar  b,
uchar  a 
)

RGBA color spec from bytes (0-255)

Color DLLEXPORT_OST_GFX ost::gfx::RGBAi ( unsigned int  r,
unsigned int  g,
unsigned int  b,
unsigned int  a 
)

RGBA color spec from integers (0-65535)

Color DLLEXPORT_OST_GFX ost::gfx::RGBb ( uchar  r,
uchar  g,
uchar  b 
)

RGB color spec from bytes (0-255)

Color DLLEXPORT_OST_GFX ost::gfx::RGBi ( unsigned int  r,
unsigned int  g,
unsigned int  b 
)

RGB color spec from integers (0-65535)

def ost.gfx.Stereo (   mode,
  flip = None,
  alg = None 
)
Stereo control

:param mode: 0=off, 1=quad-buffered, 2=interlaced
:type mode: int
:param flip: invert order of left/right display
:type flip: bool
:param alg: stereo algorithm (0 or 1)
:type param: int

Definition at line 51 of file __init__.py.

Variable Documentation

tuple BLACK = RGB(0.0,0.0,0.0)

Definition at line 24 of file __init__.py.

tuple BLUE = RGB(0.0,0.0,1.0)

Definition at line 32 of file __init__.py.

tuple CYAN = RGB(0.0,1.0,1.0)

Definition at line 38 of file __init__.py.

tuple DARKBLUE = RGB(0.0,0.0,0.5)

Definition at line 33 of file __init__.py.

tuple DARKCYAN = RGB(0.0,0.5,0.5)

Definition at line 39 of file __init__.py.

tuple DARKGREEN = RGB(0.0,0.5,0.0)

Definition at line 30 of file __init__.py.

tuple DARKMAGENTA = RGB(0.5,0.0,0.5)

Definition at line 42 of file __init__.py.

tuple DARKORANGE = RGB(0.5,0.25,0.0)

Definition at line 48 of file __init__.py.

DARKPURPLE = DARKMAGENTA

Definition at line 45 of file __init__.py.

tuple DARKRED = RGB(0.5,0.0,0.0)

Definition at line 27 of file __init__.py.

tuple DARKYELLOW = RGB(0.5,0.5,0.0)

Definition at line 36 of file __init__.py.

tuple GREEN = RGB(0.0,1.0,0.0)

Definition at line 29 of file __init__.py.

tuple GREY = RGB(0.5,0.5,0.5)

Definition at line 25 of file __init__.py.

tuple LIGHTBLUE = RGB(0.5,0.5,1.0)

Definition at line 34 of file __init__.py.

tuple LIGHTCYAN = RGB(0.5,1.0,1.0)

Definition at line 40 of file __init__.py.

tuple LIGHTGREEN = RGB(0.5,1.0,0.5)

Definition at line 31 of file __init__.py.

tuple LIGHTMAGENTA = RGB(1.0,0.5,1.0)

Definition at line 43 of file __init__.py.

tuple LIGHTORANGE = RGB(1.0,0.75,0.5)

Definition at line 49 of file __init__.py.

LIGHTPURPLE = LIGHTMAGENTA

Definition at line 46 of file __init__.py.

tuple LIGHTRED = RGB(1.0,0.5,0.5)

Definition at line 28 of file __init__.py.

tuple LIGHTYELLOW = RGB(1.0,1.0,0.5)

Definition at line 37 of file __init__.py.

tuple MAGENTA = RGB(1.0,0.0,1.0)

Definition at line 41 of file __init__.py.

tuple ORANGE = RGB(1.0,0.5,0.0)

Definition at line 47 of file __init__.py.

PURPLE = MAGENTA

Definition at line 44 of file __init__.py.

tuple RED = RGB(1.0,0.0,0.0)

Definition at line 26 of file __init__.py.

const unsigned int VA_CYL_MAX_DETAIL =12
static

Definition at line 29 of file vertex_array_helper.hh.

const unsigned int VA_ICO_SPHERE_MAX_DETAIL =4
static

Definition at line 28 of file vertex_array_helper.hh.

const unsigned int VA_SPHERE_MAX_DETAIL =12
static

Definition at line 27 of file vertex_array_helper.hh.

tuple WHITE = RGB(1.0,1.0,1.0)

Definition at line 23 of file __init__.py.

tuple YELLOW = RGB(1.0,1.0,0.0)

Definition at line 35 of file __init__.py.