MasterScan  Lab_Matlab_control Master Branch
List of all members | Properties and Events | Protected Properties | Methods | Protected Methods
dotsDrawableArcs Class Reference

Overview

Draw one or multiple arcs at once.

dotsDrawableArcs uses an OpenGL utility ("GLU") to approximate arcs which fall along the circumference of a circle.

Inheritance diagram for dotsDrawableArcs:
Inheritance graph
[legend]

Properties and Events

Property xCenter = 0
 x-coordinate for the center of each arc's circles (degrees visual angle, centered)
 
Property yCenter = 0
 y-coordinate for the center of each arc's circles (degrees visual angle, centered)
 
Property rInner = 4
 radius of each arc's inner circle (degrees visual angle)
 
Property rOuter = 5
 radius of each arc's outer circle (degrees visual angle)
 
Property startAngle = 0
 where each arc starts along its circle (degrees counterclockwise from rightward)
 
Property sweepAngle = 2*pi
 how far all each arc sweeps along its circle (degrees counterclockwise from rightward)
 
Property nPieces = 30
 how many segments make up each arc (same for all arcs)
 
- Properties and Events inherited from dotsDrawableVertices
Property x = 0
 vertex x-positions (x, y, and z must be scalar or match sizes)
 
Property y = 0
 vertex y-positions (x, y, and z must be scalar or match sizes)
 
Property z = 0
 vertex z-positions (x, y, and z must be scalar or match sizes)
 
Property colors = [1 1 1]
 color map to use for vertices [r g b a; r g b a; etc. More...
 
Property isColorByVertexGroup = false
 whether to color vertices in groups(true) or individually(false)
 
Property indices = []
 array of indices for selecting, reusing, and reordering vertices More...
 
Property pixelSize = 1
 width in pixels for points or lines
 
Property isSmooth = false
 whether to use anti-aliasing for primitives
 
Property primitive = 0
 index to choose OpenGL vertex drawing mode More...
 
Property usageHint = 3
 index to choose usage "hint" for OpenGL buffers More...
 
Property translation = []
 optional translation to apply to vertex positions [tX tY tZ] More...
 
Property rotation = []
 optional rotation of vertices about coordinate axes [rX rY rZ] More...
 
Property scaling = []
 optional scaling to apply to vertex positions [sX sY sZ] More...
 
- Properties and Events inherited from dotsDrawable
Property isVisible = true
 true or false, whether to draw() this object
 

Protected Properties

Property verticesPerDisk
 how many vertices make up each arc (same for all arcs)
 
- Protected Properties inherited from dotsDrawableVertices
Property attribBufferInfo = []
 identifier and other info for the OpenGL vertex attribute buffer
 
Property isAttribBufferStale = true
 whether or not the attribute buffer is out of date
 
Property indexBufferInfo = []
 identifier and other info for the OpenGL vertex index buffer
 
Property isIndexBufferStale = true
 whether or not the index buffer is out of date
 
Property colorBufferInfo = []
 identifier and other info for the OpenGL vertex color buffer
 
Property isColorBufferStale = true
 whether or not the color buffer is out of date
 
Property smoothMap
 map primitive integers to dotsMglSmoothness() switches
 

Methods

self dotsDrawableArcs ()
 Constructor takes no arguments.
 
 set_xCenter (self, xCenter)
 Keep track of disk changes.
 
 set_yCenter (self, yCenter)
 Keep track of disk changes.
 
 set_rInner (self, rInner)
 Keep track of disk changes.
 
 set_rOuter (self, rOuter)
 Keep track of disk changes.
 
 set_startAngle (self, startAngle)
 Keep track of disk changes.
 
 set_sweepAngle (self, sweepAngle)
 Keep track of disk changes.
 
 set_nPieces (self, nPieces)
 Keep track of disk changes.
 
- Methods inherited from dotsDrawableVertices
self dotsDrawableVertices ()
 Constructor takes no arguments.
 
 delete (self)
 Release OpenGL resources. More...
 
 set_x (self, x)
 Keep track of required buffer updates.
 
 set_y (self, y)
 Keep track of required buffer updates.
 
 set_z (self, z)
 Keep track of required buffer updates.
 
 set_indices (self, indices)
 Keep track of required buffer updates.
 
 set_colors (self, colors)
 Keep track of required buffer updates.
 
 set_isColorByVertexGroup (self, isColorByVertexGroup)
 Keep track of required buffer updates.
 
nVertices getNVertices (self)
 Calculate number of vertices from x, y, and z.
 
 prepareToDrawInWindow (self)
 Create fresh OpenGL buffer objects.
 
 draw (self)
 Draw vertices from OpenGL buffer objects.
 
- Methods inherited from dotsDrawable
self dotsDrawable ()
 Constructor takes no arguments.
 
 prepareToDrawInWindow (self)
 Do any pre-draw setup that requires an OpenGL drawing window.
 
 mayDrawNow (self)
 Draw() or not, depending on isVisible and possibly other factors.
 
 draw (self)
 Subclass must redefine draw() to draw graphics.
 
 show (self)
 Shorthand to set isVisible=true.
 
 hide (self)
 Shorthand to set isVisible=false.
 

Protected Methods

 updateDisks (self)
 Calculate quad vertex positions to approximate disks.
 
groupIndices getVertexGroupIndices (self)
 Get a 1-based arc-specific index for each vertex.
 
- Protected Methods inherited from dotsDrawableVertices
 deleteBuffers (self)
 Release OpenGL buffer handles and memory.
 
 updateBuffers (self)
 Write attribute, color, and index data to buffers, as needed.
 
 deleteAttribBuffer (self)
 Release OpenGL vertex attribute resources.
 
 updateAttribBuffer (self)
 Write new vertex attributes to OpenGL buffer(s).
 
 deleteIndexBuffer (self)
 Release OpenGL vertex index resources.
 
 updateIndexBuffer (self)
 Write new vertex indices to OpenGL buffer(s).
 
 deleteColorBuffer (self)
 Release OpenGL vertex color resources.
 
 updateColorBuffer (self)
 Write new vertex colors to OpenGL buffer(s).
 
groupIndices getVertexGroupIndices (self)
 Get an arbitrary 1-based group index for each vertex.
 
buffer overwriteOrReplaceBuffer (self, oldBuffer, data, target, elementsPerVertex)
 Modify or replace a buffer with new data.
 
 selectBuffers (self)
 Bind buffers for drawing.
 
 deselectBuffers (self)
 Unbind buffers for drawing.
 
 flagAllBuffersAsStale (self)
 Mark all OpenGL buffers as stale.
 

Additional Inherited Members

- Static Methods inherited from dotsDrawable
static frameInfo drawFrame (drawables, doClear)
 draw() several drawable objects and show the next Screen frame. More...
 
static ensemble makeEnsemble (name, objects)
 Convenient utility for combining a bunch of drawables into an ensemble. More...
 
static frameInfo drawEnsemble (ensemble, args, prepareFlag, showDuration, pauseDuration)
 Convenient utility for drawing an ensemble either locally or remotely. More...
 

The documentation for this class was generated from the following file: