Ignore:
Timestamp:
Dec 30, 2012, 2:02:26 PM (12 years ago)
Author:
ldelgass
Message:

Add documentation

Location:
branches/Rappture 1.2/packages/vizservers/vtkvis
Files:
2 edited

Legend:

Unmodified
Added
Removed

  • branches/Rappture 1.2/packages/vizservers/vtkvis/RpVtkRendererGraphicsObjs.cpp

    r3225 r3229  
    701701    } while (doAll && ++itr != _dataSets.end());
    702702
    703     if (_cameraMode == IMAGE)
    704         setCameraMode(PERSPECTIVE);
    705703    initCamera();
    706704    _needsRedraw = true;
    … …  
    987985}
    988986
     987/**
     988 * \brief Set scalar interpolation mode for the specified DataSet
     989 */
    989990void Renderer::setCutplaneInterpolateBeforeMapping(const DataSetId& id, bool state)
    990991{
    … …  
    11811182
    11821183    initCamera();
    1183 
    11841184    _needsRedraw = true;
    11851185    return true;
    … …  
    14031403
    14041404    initCamera();
    1405 
    14061405    _needsRedraw = true;
    14071406    return true;
    … …  
    14511450
    14521451    initCamera();
    1453 
    14541452    _needsRedraw = true;
    14551453    return true;
    … …  
    15411539}
    15421540
     1541/**
     1542 * \brief Set scalar interpolation mode for the specified DataSet
     1543 */
    15431544void Renderer::setHeightMapInterpolateBeforeMapping(const DataSetId& id, bool state)
    15441545{
    … …  
    19381939}
    19391940
     1941/**
     1942 * \brief Set render style of the Molecule bonds for the given DataSet
     1943 */
    19401944void Renderer::setMoleculeBondStyle(const DataSetId& id, Molecule::BondStyle style)
    19411945{
    … …  
    19621966}
    19631967
     1968/**
     1969 * \brief Set coloring mode of the Molecule bonds for the given DataSet
     1970 */
    19641971void Renderer::setMoleculeBondColorMode(const DataSetId& id, Molecule::BondColorMode mode)
    19651972{
    … …  
    19861993}
    19871994
     1995/**
     1996 * \brief Set constant color of the Molecule bonds for the given DataSet
     1997 */
    19881998void Renderer::setMoleculeBondColor(const DataSetId& id, float color[3])
    19891999{
    … …  
    20092019    _needsRedraw = true;
    20102020}
    2011 
    20122021
    20132022/**
    … …  
    21642173}
    21652174
     2175/**
     2176 * \brief Set scalar interpolation mode for the specified DataSet
     2177 */
    21662178void Renderer::setPseudoColorInterpolateBeforeMapping(const DataSetId& id, bool state)
    21672179{

  • branches/Rappture 1.2/packages/vizservers/vtkvis/RpVtkRendererGraphicsObjs.h

    r3177 r3229  
    1717namespace VtkVis {
    1818
     19/**
     20 * \brief Look up graphics object by name
     21 */
    1922template<class GraphicsObject>
    2023GraphicsObject *Renderer::getGraphicsObject(const DataSetId& id)
    … …  
    3437}
    3538
     39/**
     40 * \brief Delete graphics object by name
     41 */
    3642template<class GraphicsObject>
    3743void Renderer::deleteGraphicsObject(const DataSetId& id)
    … …  
    7177}
    7278
     79/**
     80 * \brief Delete all graphics objects from renderer
     81 */
    7382template<class GraphicsObject>
    7483void Renderer::deleteAllGraphicsObjects()
    … …  
    9099}
    91100
     101/**
     102 * \brief Add a graphics objects to the renderer's scene
     103 */
    92104template<class GraphicsObject>
    93105bool Renderer::addGraphicsObject(const DataSetId& id)
    … …  
    415427        itr->second->setColor(color);
    416428    } while (doAll && ++itr != hashmap.end());
     429
    417430    _needsRedraw = true;
    418431}
    … …  
    627640        itr->second->setLighting(state);
    628641    } while (doAll && ++itr != hashmap.end());
     642
    629643    _needsRedraw = true;
    630644}
    … …  
    765779}
    766780
     781/**
     782 * \brief Notify graphics object that color map has changed
     783 */
    767784template<class GraphicsObject>
    768785void Renderer::updateGraphicsObjectColorMap(ColorMap *cmap)
    … …  
    780797}
    781798
     799/**
     800 * \brief Check if a color map is in use by a graphics object
     801 */
    782802template<class GraphicsObject>
    783803bool Renderer::graphicsObjectColorMapUsed(ColorMap *cmap)
    … …  
    794814}
    795815
     816/**
     817 * \brief Compute union of bounds and GO's bounds
     818 */
    796819template<class GraphicsObject>
    797820void Renderer::mergeGraphicsObjectBounds(double *bounds, bool onlyVisible)
    … …  
    808831}
    809832
     833/**
     834 * \brief Compute union of bounds and GO's unscaled bounds
     835 *
     836 * Unscaled bounds are the bounds of the object before any actor scaling is
     837 * applied
     838 */
    810839template<class GraphicsObject>
    811840void Renderer::mergeGraphicsObjectUnscaledBounds(double *bounds, bool onlyVisible)
    … …  
    822851}
    823852
     853/**
     854 * \brief Notify object that field value ranges have changed
     855 */
    824856template<class GraphicsObject>
    825857void Renderer::updateGraphicsObjectFieldRanges()
    … …  
    834866}
    835867
     868/**
     869 * \brief Pass global clip planes to graphics object
     870 */
    836871template<class GraphicsObject>
    837872void Renderer::setGraphicsObjectClippingPlanes(vtkPlaneCollection *planes)
    … …  
    846881}
    847882
     883/**
     884 * \brief Set actor scaling based on a 2D aspect ratio
     885 *
     886 * \param aspectRatio The aspect ratio (width/height), zero means native aspect
     887 */
    848888template<class GraphicsObject>
    849889void Renderer::setGraphicsObjectAspect(double aspectRatio)
Note: See TracChangeset for help on using the changeset viewer.