Software Project Documentation
Automatically generated with Code Structure Viewer (CS), Project Version: 3o4d 17-November-2020
Copyright © 2020, BAI Research. All Rights Reserved.
Software Project Code Structure - Files
Software Project Code Structure - Functions
File RTmain Documentation
File Name: RTmain.cpp/.hpp
File Description: RT main
File Function List
File Diagram (functions hierarchy)
Function main()
Function Summary
name | return type | description |
main | int | main |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
Function Reference List
-
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getFloatArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::getCurrentDirectory
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::argumentExists
- SHAREDvarsClass::getStringArgument
- SHAREDvarsClass::setCurrentDirectory
- SHAREDvarsClass::argumentExists
- LDparserClass::parseFile
- SHAREDvarsClass::setCurrentDirectory
- LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile
- RTreferenceManipulationClass::write2DReferenceListCollapsedTo1DToFileRayTraceFormat
- RTsceneClass::setLightingMode
- RTsceneClass::rayTraceScene
File RTscene Documentation
File Name: RTscene.cpp/.hpp
File Description: RT scene
File Function List
-
- rayTraceScene
- rayTraceSceneWithoutParse
- setLightingMode
- parseTalFileInitialiseParser
- parseTalFileGetViewInfo
- parseTalFileGetLightInfo
- parseTalFileGetSceneInfo
- createImage
- calculateTransparencyColour
- calculateUVNScalars
- calculateAmbientDiffuseSpecular
- calculateBasicColour
- stripExtension
- addExtension
File Diagram (functions hierarchy)
Class RTlightingInfo
Class Data
name | type | description |
ls | RTlightSource | ls |
nextLight | RTlightingInfo* | next light |
Function RTsceneClass::rayTraceScene()
Function Summary
name | return type | description |
rayTraceScene | int | ray trace scene |
Function Arguments
name | type | description |
talFileName | const string | tal file name |
imageFileName | string | image file name |
outputImageFiles | const int | output image files |
setRGBAndDepthAndNormalAndPointMaps | const int | set RGBA nd depth and normal and point maps |
rgbMap | uchar* | rgb map |
depthMap | double* | depth map |
normalMap | double* | normal map |
pointMap | double* | point map |
Function Reference List
-
- RTpixelMapsClass::fillInRTRulesExternVariables
- parseTalFileInitialiseParser
- parseTalFileGetViewInfo
- parseTalFileGetLightInfo
- parseTalFileGetSceneInfo
- RTparserClass::exitParser
- SHAREDvarsClass::setCurrentDirectory
- rayTraceSceneWithoutParse
Function RTsceneClass::rayTraceSceneWithoutParse()
Function Summary
name | return type | description |
rayTraceSceneWithoutParse | int | ray trace scene without parse |
Function Arguments
name | type | description |
vi | RTviewInfo* | vi |
si | RTsceneInfo* | si |
li | const RTlightingInfo* | li |
imageFileName | string | image file name |
outputImageFiles | const int | output image files |
setRGBAndDepthAndNormalAndPointMaps | const int | set RGBA nd depth and normal and point maps |
rgbMap | uchar* | rgb map |
depthMap | double* | depth map |
normalMap | double* | normal map |
pointMap | double* | point map |
Function Reference List
-
- createImage
- createImage
- RTppmClass::newPixmap
- RTppmClass::newPixmap
- RTppmClass::newPixmap
-
- RTpixelMapsClass::getRGBMapValues
- RTppmClass::placepointPPM
- RTpixelMapsClass::getNormalMapValue
- RTppmClass::placepointPPM
- RTpixelMapsClass::getLumOrContrastOrDepthMapValue
- SHAREDvarsClass::minInt
- RTppmClass::placepointPPM
- RTpixelMapsClass::writeImage
- stripExtension
- addExtension
- RTpixelMapsClass::writeImage
- RTpixelMapsClass::writeImage
Function RTsceneClass::setLightingMode()
Function Summary
name | return type | description |
setLightingMode | void | set lighting mode |
Function Arguments
name | type | description |
newLightingMode | const int | new lighting mode |
Function Reference List
N/A
Function RTsceneClass::parseTalFileInitialiseParser()
Function Summary
name | return type | description |
parseTalFileInitialiseParser | void | parse tal file initialise parser |
Function Arguments
name | type | description |
talFileName | const string | tal file name |
Function Reference List
-
-
- RTparserClass::initParser
Function RTsceneClass::parseTalFileGetViewInfo()
Function Summary
name | return type | description |
parseTalFileGetViewInfo | RTviewInfo* | parse tal file get view info |
Function Arguments
name | type | description |
vi | RTviewInfo* | vi |
Function Reference List
-
- RTparserClass::readViewport
- RTparserClass::get_view_info
Function RTsceneClass::parseTalFileGetLightInfo()
Function Summary
name | return type | description |
parseTalFileGetLightInfo | RTlightingInfo* | parse tal file get light info |
Function Arguments
name | type | description |
li | RTlightingInfo* | li |
Function Reference List
-
- RTparserClass::nextLightSource
- RTparserClass::get_light_info
Function RTsceneClass::parseTalFileGetSceneInfo()
Function Summary
name | return type | description |
parseTalFileGetSceneInfo | RTsceneInfo* | parse tal file get scene info |
Function Arguments
name | type | description |
si | RTsceneInfo* | si |
Function Reference List
-
- RTparserClass::nextSceneCommand
- RTparserClass::getPieceInfo
- RTparserClass::getDimensionsInfo
- RToperationsClass::createRotationxMatrix
- RToperationsClass::toRadians
- RToperationsClass::createRotationyMatrix
- RToperationsClass::toRadians
- RToperationsClass::createRotationzMatrix
- RToperationsClass::toRadians
- RToperationsClass::createTranslationMatrix
- RToperationsClass::createScaleMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::createInverseRotationxMatrix
- RToperationsClass::toRadians
- RToperationsClass::createInverseRotationyMatrix
- RToperationsClass::toRadians
- RToperationsClass::createInverseRotationzMatrix
- RToperationsClass::toRadians
- RToperationsClass::createInverseTranslationMatrix
- RToperationsClass::createInverseScaleMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
Function RTsceneClass::createImage()
Function Summary
name | return type | description |
createImage | void | create image |
Function Arguments
name | type | description |
setRGBAndDepthAndNormalAndPointMaps | const int | set RGBA nd depth and normal and point maps |
rgbMap | uchar* | rgb map |
depthMap | double* | depth map |
normalMap | double* | normal map |
pointMap | double* | point map |
vi | RTviewInfo* | vi |
si | RTsceneInfo* | si |
li | const RTlightingInfo* | li |
Function Reference List
-
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::normaliseVector
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::normaliseVector
- SHAREDvectorClass::crossProduct
- SHAREDvectorClass::normaliseVector
- SHAREDvectorClass::crossProduct
- SHAREDvectorClass::normaliseVector
- SHAREDvectorClass::makeMatrix
-
- calculateUVNScalars
- RTraytracerClass::rayTrace
- calculateBasicColour
- calculateTransparencyColour
- calculateAmbientDiffuseSpecular
- RTpixelMapsClass::setRGBMapValues
- RTpixelMapsClass::setLumOrContrastOrDepthMapValue
- RTpixelMapsClass::setNormalMapValue
- RTpixelMapsClass::setPointMapValue
Function RTsceneClass::calculateTransparencyColour()
Function Summary
name | return type | description |
calculateTransparencyColour | void | calculate transparency colour |
Function Arguments
name | type | description |
vi | const RTviewInfo* | vi |
si | const RTsceneInfo* | si |
li | const RTlightingInfo* | li |
rgb | colour* | rgb |
Function Reference List
N/A
Function RTsceneClass::calculateUVNScalars()
Function Summary
name | return type | description |
calculateUVNScalars | void | calculate UVNS calars |
Function Arguments
name | type | description |
vi | const RTviewInfo* | vi |
uvn | vec* | uvn |
x | const int | x |
y | const int | y |
Function Reference List
N/A
Function RTsceneClass::calculateAmbientDiffuseSpecular()
Function Summary
name | return type | description |
calculateAmbientDiffuseSpecular | void | calculate ambient diffuse specular |
Function Arguments
name | type | description |
vi | RTviewInfo* | vi |
si | const RTsceneInfo* | si |
li | const RTlightingInfo* | li |
rgb | colour* | rgb |
tAtSurface | double* | tAt surface |
nAtSurface | vec* | nAt surface |
pointAtSurface | vec* | point at surface |
Function Reference List
-
-
-
- SHAREDvectorClass::subtractVectorsRT
- SHAREDvectorClass::normaliseVector
- SHAREDvectorClass::subtractVectorsRT
- SHAREDvectorClass::normaliseVector
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::subtractVectorsRT
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
Function RTsceneClass::calculateBasicColour()
Function Summary
name | return type | description |
calculateBasicColour | void | calculate basic colour |
Function Arguments
name | type | description |
vi | const RTviewInfo* | vi |
si | const RTsceneInfo* | si |
li | const RTlightingInfo* | li |
rgb | colour* | rgb |
tAtSurface | double* | tAt surface |
nAtSurface | vec* | nAt surface |
pointAtSurface | vec* | point at surface |
Function Reference List
-
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
Function RTsceneClass::stripExtension()
Function Summary
name | return type | description |
stripExtension | bool | strip extension |
Function Arguments
name | type | description |
filenameWithExtension | string | filename with extension |
filenameWithoutExtension | string* | filename without extension |
Function Reference List
N/A
Function RTsceneClass::addExtension()
Function Summary
name | return type | description |
addExtension | bool | add extension |
Function Arguments
name | type | description |
filenameWithoutExtension | string | filename without extension |
extension | string | extension |
filenameWithExtension | string* | filename with extension |
Function Reference List
N/A
File RTraytracer Documentation
File Name: RTraytracer.cpp/.hpp
File Description: RT raytracer
File Function List
-
- rayTrace
- calculateCylinder
- calculateCube
- calculateSphere
- calculatePrimQuad
- calculatePrimTri
- calculatePrimLine
- drawPoint
- drawPointNoLighting
File Diagram (functions hierarchy)
Class RTsceneInfo
Class Data
name | type | description |
standardMatrix | advancedMat | standard matrix |
reverseMatrix | advancedMat | reverse matrix |
pi | RTpieceInfo | pi |
di | RTdimensionsInfo | di |
tOut | double | tOut |
n | vec | n |
nextScene | RTsceneInfo* | next scene |
Function RTraytracerClass::rayTrace()
Function Summary
name | return type | description |
rayTrace | void | ray trace |
Function Arguments
name | type | description |
vi | const RTviewInfo* | vi |
si | RTsceneInfo* | si |
tildaMat | mat* | tilda mat |
uvn | vec* | uvn |
Function Reference List
-
- SHAREDvectorClass::multMatrixByVector
- SHAREDvectorClass::addVectorsRT
- RToperationsClass::createInverseScaleMatrix
- RToperationsClass::createInverseTranslationMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::toAdvancedVector
- RToperationsClass::toAdvancedVector
- RToperationsClass::multAdvancedMatrixByVector
- RToperationsClass::multAdvancedMatrixByVector
- RToperationsClass::fromAdvancedVector
- RToperationsClass::fromAdvancedVector
- calculateCube
- calculateCylinder
- calculateSphere
- calculatePrimQuad
- calculatePrimTri
- calculatePrimLine
- SHAREDvectorClass::createVector
- SHAREDvectorClass::createVector
- drawPoint
- drawPoint
- drawPoint
- drawPoint
- drawPoint
- drawPointNoLighting
Function RTraytracerClass::calculateCylinder()
Function Summary
name | return type | description |
calculateCylinder | void | calculate cylinder |
Function Arguments
name | type | description |
p0 | vec* | p0 |
p1 | vec* | p1 |
tInOut | double* | tIn out |
norm | vec* | norm |
finalReverseMatrix | advancedMat* | final reverse matrix |
relevantFinalReverseMatrix | advancedMat* | relevant final reverse matrix |
Function Reference List
-
-
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- RToperationsClass::findPositionOfSmallestValueWhichHits
- RToperationsClass::findPositionOfGreatestValueWhichHits
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
Function RTraytracerClass::calculateCube()
Function Summary
name | return type | description |
calculateCube | void | calculate cube |
Function Arguments
name | type | description |
p0 | vec* | p0 |
p1 | vec* | p1 |
tInOut | double* | tIn out |
norm | vec* | norm |
finalReverseMatrix | advancedMat* | final reverse matrix |
relevantFinalReverseMatrix | advancedMat* | relevant final reverse matrix |
Function Reference List
-
-
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- RToperationsClass::findGreatestValue
- RToperationsClass::findSmallestValue
- RToperationsClass::findPositionOfSmallestValueWhichHits
- RToperationsClass::findPositionOfGreatestValueWhichHits
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
Function RTraytracerClass::calculateSphere()
Function Summary
name | return type | description |
calculateSphere | void | calculate sphere |
Function Arguments
name | type | description |
p0 | vec* | p0 |
p1 | vec* | p1 |
tInOut | double* | tIn out |
norm | vec* | norm |
finalReverseMatrix | advancedMat* | final reverse matrix |
relevantFinalReverseMatrix | advancedMat* | relevant final reverse matrix |
Function Reference List
-
- SHAREDvectorClass::subtractVectorsRT
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::dotProduct
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
Function RTraytracerClass::calculatePrimQuad()
Function Summary
name | return type | description |
calculatePrimQuad | void | calculate prim quad |
Function Arguments
name | type | description |
p0 | vec* | p0 |
p1 | vec* | p1 |
tInOut | double* | tIn out |
pi | const RTpieceInfo* | pi |
norm | vec* | norm |
finalReverseMatrix | advancedMat* | final reverse matrix |
relevantFinalReverseMatrix | advancedMat* | relevant final reverse matrix |
Function Reference List
-
- RToperationsClass::findIntersectLineWithQuad
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::negativeVector
Function RTraytracerClass::calculatePrimTri()
Function Summary
name | return type | description |
calculatePrimTri | void | calculate prim tri |
Function Arguments
name | type | description |
p0 | vec* | p0 |
p1 | vec* | p1 |
tInOut | double* | tIn out |
pi | const RTpieceInfo* | pi |
norm | vec* | norm |
finalReverseMatrix | advancedMat* | final reverse matrix |
relevantFinalReverseMatrix | advancedMat* | relevant final reverse matrix |
Function Reference List
-
- RToperationsClass::findIntersectLineWithTri
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::negativeVector
Function RTraytracerClass::calculatePrimLine()
Function Summary
name | return type | description |
calculatePrimLine | void | calculate prim line |
Function Arguments
name | type | description |
p0 | vec* | p0 |
p1 | vec* | p1 |
tInOut | double* | tIn out |
pi | const RTpieceInfo* | pi |
norm | const vec* | norm |
finalReverseMatrix | advancedMat* | final reverse matrix |
relevantFinalReverseMatrix | advancedMat* | relevant final reverse matrix |
Function Reference List
-
- SHAREDvectorClass::subtractVectorsRT
- RToperationsClass::findIntersectLineWithLine
Function RTraytracerClass::drawPoint()
Function Summary
name | return type | description |
drawPoint | void | draw point |
Function Arguments
name | type | description |
si | RTsceneInfo* | si |
reverseMatrix | advancedMat* | reverse matrix |
tInDash | double | tIn dash |
tOutDash | double | tOut dash |
p0Dash | vec* | p0D ash |
p1Dash | vec* | p1D ash |
norm | vec* | norm |
Function Reference List
-
- SHAREDvectorClass::negativeVector
- SHAREDvectorClass::addVectorsRT
- SHAREDvectorClass::multiplyVectorByScalarRT
- SHAREDvectorClass::addVectorsRT
- RToperationsClass::toAdvancedVector
- RToperationsClass::multAdvancedMatrixByVector
- RToperationsClass::fromAdvancedVector
- SHAREDvectorClass::subtractVectorsRT
- SHAREDvectorClass::subtractVectorsRT
- RToperationsClass::createAdvancedVector
- RToperationsClass::toAdvancedVector
- RToperationsClass::transposeAdvancedMatrix
- RToperationsClass::multAdvancedMatrixByVector
- RToperationsClass::fromAdvancedVector
- SHAREDvectorClass::normaliseVector
Function RTraytracerClass::drawPointNoLighting()
Function Summary
name | return type | description |
drawPointNoLighting | void | draw point no lighting |
Function Arguments
name | type | description |
si | RTsceneInfo* | si |
reverseMatrix | const advancedMat* | reverse matrix |
tIn | double | tIn |
tOut | double | tOut |
p0 | const vec* | p0 |
p1 | const vec* | p1 |
norm | const vec* | norm |
Function Reference List
N/A
File RTparser Documentation
File Name: RTparser.cpp/.hpp
File Description: RT parser
File Function List
-
- initParser
- readViewport
- get_view_info
- nextLightSource
- get_light_info
- nextSceneCommand
- getPieceInfo
- getDimensionsInfo
- exitParser
File Diagram (functions hierarchy)
Class RTlightSource
Class Data
name | type | description |
type | lightType | type |
pos | vec | pos |
col | colour | col |
Class RTpieceInfo
Class Data
name | type | description |
type | pieceType | type |
col | colour | col |
pos | vec | pos |
xrot | double | xrot |
yrot | double | yrot |
zrot | double | zrot |
vertex1Position | vec | vertex 1P osition |
vertex2Position | vec | vertex 2P osition |
vertex3Position | vec | vertex 3P osition |
vertex4Position | vec | vertex 4P osition |
Class RTdimensionsInfo
Class Data
name | type | description |
width | double | width |
length | double | length |
height | double | height |
translucent | int | translucent |
transparency | int | transparency |
is_invisible | int | is _invisible |
Class RTdecalInfo
Class Data
name | type | description |
width | double | width |
length | double | length |
filename | char* | filename |
haveTransparent | int | have transparent |
transparentcolour | colour | transparentcolour |
Class RTunknownInfo
Class Data
name | type | description |
commandString | char* | command string |
param_count | int | param _count |
*params | char* | *params |
Function RTparserClass::initParser()
Function Summary
name | return type | description |
initParser | void | init parser |
Function Arguments
name | type | description |
f | FILE* | f |
Function Reference List
N/A
Function RTparserClass::readViewport()
Function Summary
name | return type | description |
readViewport | int | read viewport |
Function Reference List
N/A
Function RTparserClass::get_view_info()
Function Summary
name | return type | description |
get_view_info | RTviewInfo* | get _view _info |
Function Reference List
N/A
Function RTparserClass::nextLightSource()
Function Summary
name | return type | description |
nextLightSource | int | next light source |
Function Reference List
N/A
Function RTparserClass::get_light_info()
Function Summary
name | return type | description |
get_light_info | RTlightSource* | get _light _info |
Function Reference List
N/A
Function RTparserClass::nextSceneCommand()
Function Summary
name | return type | description |
nextSceneCommand | int | next scene command |
Function Reference List
N/A
Function RTparserClass::getPieceInfo()
Function Summary
name | return type | description |
getPieceInfo | RTpieceInfo* | get piece info |
Function Reference List
N/A
Function RTparserClass::getDimensionsInfo()
Function Summary
name | return type | description |
getDimensionsInfo | RTdimensionsInfo* | get dimensions info |
Function Reference List
N/A
Function RTparserClass::exitParser()
Function Summary
name | return type | description |
exitParser | void | exit parser |
Function Reference List
N/A
File SHAREDvars Documentation
File Name: SHAREDvars.cpp/.hpp
File Description: SHARED vars
File Function List
-
- compareDoubles
- minInt
- argumentExists
- getFloatArgument
- getStringArgument
- getCurrentDirectory
- convertDoubleToString
- convertIntToString
- convertUnsignedIntToString
- convertStringToDouble
- sprintfSafeDouble
- sprintfSafeInt
File Diagram (functions hierarchy)
Function SHAREDvarsClass::compareDoubles()
Function Summary
name | return type | description |
compareDoubles | bool | compare doubles |
Function Arguments
name | type | description |
a | const double | a |
b | const double | b |
Function Reference List
N/A
Function SHAREDvarsClass::minInt()
Function Summary
name | return type | description |
minInt | int | min int |
Function Arguments
name | type | description |
a | int | a |
b | const int | b |
Function Reference List
N/A
Function SHAREDvarsClass::argumentExists()
Function Summary
name | return type | description |
argumentExists | bool | argument exists |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
keystr | const string | keystr |
Function Reference List
N/A
Function SHAREDvarsClass::getFloatArgument()
Function Summary
name | return type | description |
getFloatArgument | float | get float argument |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
keystr | const string | keystr |
Function Reference List
N/A
Function SHAREDvarsClass::getStringArgument()
Function Summary
name | return type | description |
getStringArgument | string | get string argument |
Function Arguments
name | type | description |
argc | const int | argc |
argv | const char** | argv |
keystr | const string | keystr |
Function Reference List
N/A
Function SHAREDvarsClass::getCurrentDirectory()
Function Summary
name | return type | description |
getCurrentDirectory | string | get current directory |
Function Reference List
N/A
Function SHAREDvarsClass::setCurrentDirectory()
Function Summary
name | return type | description |
setCurrentDirectory | void | set current directory |
Function Arguments
name | type | description |
folder | const string* | folder |
Function Reference List
N/A
Function SHAREDvarsClass::convertDoubleToString()
Function Summary
name | return type | description |
convertDoubleToString | string | convert double to string |
Function Arguments
name | type | description |
number | const double | number |
format | const string | format |
Function Reference List
Function SHAREDvarsClass::convertIntToString()
Function Summary
name | return type | description |
convertIntToString | string | convert int to string |
Function Arguments
name | type | description |
number | const int | number |
Function Reference List
Function SHAREDvarsClass::convertUnsignedIntToString()
Function Summary
name | return type | description |
convertUnsignedIntToString | string | convert unsigned int to string |
Function Arguments
name | type | description |
number | const int | number |
Function Reference List
Function SHAREDvarsClass::convertStringToDouble()
Function Summary
name | return type | description |
convertStringToDouble | double | convert string to double |
Function Arguments
name | type | description |
number | const string | number |
Function Reference List
N/A
Function SHAREDvarsClass::sprintfSafeDouble()
Function Summary
name | return type | description |
sprintfSafeDouble | void | sprintf safe double |
Function Arguments
name | type | description |
stringCharStar | char* | string char star |
type | const char* | type |
number | double | number |
Function Reference List
N/A
Function SHAREDvarsClass::sprintfSafeInt()
Function Summary
name | return type | description |
sprintfSafeInt | void | sprintf safe int |
Function Arguments
name | type | description |
stringCharStar | char* | string char star |
type | const char* | type |
number | int | number |
Function Reference List
N/A
File RToperations Documentation
File Name: RToperations.cpp/.hpp
File Description: RT operations
File Function List
-
- makeAdvancedMatrix
- multAdvancedMatrix
- createIdentityMatrixAdvanced
- createInverseTranslationMatrix
- createTranslationMatrix
- createScaleMatrix
- createInverseScaleMatrix
- createRotationxMatrix
- createInverseRotationxMatrix
- createRotationyMatrix
- createInverseRotationyMatrix
- createRotationzMatrix
- createInverseRotationzMatrix
- invertAdvancedMatrix
- transposeAdvancedMatrix
- multAdvancedMatrixByVector
- toRadians
- toAdvancedVector
- fromAdvancedVector
- createAdvancedVector
- findSmallestValue
- findGreatestValue
- findIntersectLineWithTri
- findIntersectLineWithLine
- findIntersectLineWithLine2D
- findIntersectLineWithQuad
- findPositionOfSmallestValueWhichHits
- findPositionOfGreatestValueWhichHits
File Diagram (functions hierarchy)
Function RToperationsClass::makeAdvancedMatrix()
Function Summary
name | return type | description |
makeAdvancedMatrix | void | make advanced matrix |
Function Arguments
name | type | description |
matxAdv | advancedMat* | matx adv |
matx | mat* | matx |
type | int | type |
Function Reference List
N/A
Function RToperationsClass::multAdvancedMatrix()
Function Summary
name | return type | description |
multAdvancedMatrix | void | mult advanced matrix |
Function Arguments
name | type | description |
matxAdv1 | advancedMat* | matx adv 1 |
matxAdv2 | advancedMat* | matx adv 2 |
matxAdv | advancedMat* | matx adv |
Function Reference List
N/A
Function RToperationsClass::createIdentityMatrixAdvanced()
Function Summary
name | return type | description |
createIdentityMatrixAdvanced | void | create identity matrix advanced |
Function Arguments
name | type | description |
matx | advancedMat* | matx |
Function Reference List
N/A
Function RToperationsClass::createInverseTranslationMatrix()
Function Summary
name | return type | description |
createInverseTranslationMatrix | void | create inverse translation matrix |
Function Arguments
name | type | description |
xpos | double | xpos |
ypos | double | ypos |
zpos | double | zpos |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createTranslationMatrix()
Function Summary
name | return type | description |
createTranslationMatrix | void | create translation matrix |
Function Arguments
name | type | description |
xpos | double | xpos |
ypos | double | ypos |
zpos | double | zpos |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createScaleMatrix()
Function Summary
name | return type | description |
createScaleMatrix | void | create scale matrix |
Function Arguments
name | type | description |
width | double | width |
length | double | length |
height | double | height |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createInverseScaleMatrix()
Function Summary
name | return type | description |
createInverseScaleMatrix | void | create inverse scale matrix |
Function Arguments
name | type | description |
width | const double | width |
length | const double | length |
height | const double | height |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createRotationxMatrix()
Function Summary
name | return type | description |
createRotationxMatrix | void | create rotationx matrix |
Function Arguments
name | type | description |
rotation | double | rotation |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createInverseRotationxMatrix()
Function Summary
name | return type | description |
createInverseRotationxMatrix | void | create inverse rotationx matrix |
Function Arguments
name | type | description |
rotation | double | rotation |
matx | advancedMat* | matx |
Function Reference List
-
- createRotationxMatrix
- invertAdvancedMatrix
Function RToperationsClass::createRotationyMatrix()
Function Summary
name | return type | description |
createRotationyMatrix | void | create rotationy matrix |
Function Arguments
name | type | description |
rotation | double | rotation |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createInverseRotationyMatrix()
Function Summary
name | return type | description |
createInverseRotationyMatrix | void | create inverse rotationy matrix |
Function Arguments
name | type | description |
rotation | double | rotation |
matx | advancedMat* | matx |
Function Reference List
-
- createRotationyMatrix
- invertAdvancedMatrix
Function RToperationsClass::createRotationzMatrix()
Function Summary
name | return type | description |
createRotationzMatrix | void | create rotationz matrix |
Function Arguments
name | type | description |
rotation | double | rotation |
matx | advancedMat* | matx |
Function Reference List
-
- createIdentityMatrixAdvanced
Function RToperationsClass::createInverseRotationzMatrix()
Function Summary
name | return type | description |
createInverseRotationzMatrix | void | create inverse rotationz matrix |
Function Arguments
name | type | description |
rotation | double | rotation |
matx | advancedMat* | matx |
Function Reference List
-
- createRotationzMatrix
- invertAdvancedMatrix
Function RToperationsClass::invertAdvancedMatrix()
Function Summary
name | return type | description |
invertAdvancedMatrix | void | invert advanced matrix |
Function Arguments
name | type | description |
matx | advancedMat* | matx |
Function Reference List
Function RToperationsClass::transposeAdvancedMatrix()
Function Summary
name | return type | description |
transposeAdvancedMatrix | void | transpose advanced matrix |
Function Arguments
name | type | description |
matx | advancedMat* | matx |
Function Reference List
N/A
Function RToperationsClass::multAdvancedMatrixByVector()
Function Summary
name | return type | description |
multAdvancedMatrixByVector | void | mult advanced matrix by vector |
Function Arguments
name | type | description |
vecAdv1 | advancedVec* | vec adv 1 |
matxAdv1 | advancedMat* | matx adv 1 |
vecAdv | advancedVec* | vec adv |
Function Reference List
N/A
Function RToperationsClass::toRadians()
Function Summary
name | return type | description |
toRadians | double | to radians |
Function Arguments
name | type | description |
degrees | const double | degrees |
Function Reference List
N/A
Function RToperationsClass::toAdvancedVector()
Function Summary
name | return type | description |
toAdvancedVector | void | to advanced vector |
Function Arguments
name | type | description |
vec | vec* | vec |
type | int | type |
vecAdv | advancedVec* | vec adv |
Function Reference List
N/A
Function RToperationsClass::fromAdvancedVector()
Function Summary
name | return type | description |
fromAdvancedVector | void | from advanced vector |
Function Arguments
name | type | description |
vecAdv | advancedVec* | vec adv |
vec | vec* | vec |
Function Reference List
N/A
Function RToperationsClass::createAdvancedVector()
Function Summary
name | return type | description |
createAdvancedVector | void | create advanced vector |
Function Arguments
name | type | description |
vec | advancedVec* | vec |
Function Reference List
N/A
Function RToperationsClass::findSmallestValue()
Function Summary
name | return type | description |
findSmallestValue | double | find smallest value |
Function Arguments
name | type | description |
val1 | const double | val 1 |
val2 | const double | val 2 |
val3 | double | val 3 |
Function Reference List
N/A
Function RToperationsClass::findGreatestValue()
Function Summary
name | return type | description |
findGreatestValue | double | find greatest value |
Function Arguments
name | type | description |
val1 | const double | val 1 |
val2 | const double | val 2 |
val3 | double | val 3 |
Function Reference List
N/A
Function RToperationsClass::findIntersectLineWithTri()
Function Summary
name | return type | description |
findIntersectLineWithTri | int | find intersect line with tri |
Function Arguments
name | type | description |
pt1 | const vec* | pt 1 |
pt2 | const vec* | pt 2 |
pt3 | const vec* | pt 3 |
linept1 | vec* | linept 1 |
linept2 | vec* | linept 2 |
pt_int | vec* | pt _int |
norm | vec* | norm |
t | double* | t |
Function Reference List
-
- SHAREDvectorClass::subtractVectorsRT
Function RToperationsClass::checkSameClockDir()
Function Summary
name | return type | description |
checkSameClockDir | int | check same clock dir |
Function Arguments
name | type | description |
pt1 | const vec* | pt 1 |
pt2 | const vec* | pt 2 |
pt3 | const vec* | pt 3 |
norm | const vec* | norm |
Function Reference List
N/A
Function RToperationsClass::findIntersectLineWithLine()
Function Summary
name | return type | description |
findIntersectLineWithLine | int | find intersect line with line |
Function Arguments
name | type | description |
linept1 | const vec* | linept 1 |
linept2 | const vec* | linept 2 |
povpt1 | vec* | povpt 1 |
povpt2 | vec* | povpt 2 |
pt_int | vec* | pt _int |
norm | const vec* | norm |
t | double* | t |
Function Reference List
-
- findIntersectLineWithLine2D
Function RToperationsClass::findIntersectLineWithLine2D()
Function Summary
name | return type | description |
findIntersectLineWithLine2D | bool | find intersect line with line 2D |
Function Arguments
name | type | description |
povpt1 | const vec* | povpt 1 |
povpt2 | const vec* | povpt 2 |
linept1 | const vec* | linept 1 |
linept2 | const vec* | linept 2 |
pt_int | vec* | pt _int |
Function Reference List
-
- SHAREDvectorClass::find2DintersectionPoint
- SHAREDvectorClass::find2DintersectionPoint
- SHAREDvectorClass::find2DintersectionPoint
-
- SHAREDvectorClass::compareDoublesRelaxed
- SHAREDvectorClass::compareDoublesRelaxed
- SHAREDvectorClass::compareDoublesRelaxed
Function RToperationsClass::findIntersectLineWithQuad()
Function Summary
name | return type | description |
findIntersectLineWithQuad | int | find intersect line with quad |
Function Arguments
name | type | description |
pt1 | const vec* | pt 1 |
pt2 | const vec* | pt 2 |
pt3 | const vec* | pt 3 |
pt4 | const vec* | pt 4 |
linept1 | vec* | linept 1 |
linept2 | vec* | linept 2 |
pt_int | vec* | pt _int |
norm | vec* | norm |
t | double* | t |
Function Reference List
-
- findIntersectLineWithTri
- findIntersectLineWithTri
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
- SHAREDvectorClass::copyVectorRT
Function RToperationsClass::findPositionOfSmallestValueWhichHits()
Function Summary
name | return type | description |
findPositionOfSmallestValueWhichHits | int | find position of smallest value which hits |
Function Arguments
name | type | description |
array | const double* | array |
hitsArray | const int* | hits array |
size | const int | size |
Function Reference List
N/A
Function RToperationsClass::findPositionOfGreatestValueWhichHits()
Function Summary
name | return type | description |
findPositionOfGreatestValueWhichHits | int | find position of greatest value which hits |
Function Arguments
name | type | description |
array | const double* | array |
hitsArray | const int* | hits array |
size | const int | size |
Function Reference List
N/A
File SHAREDvector Documentation
File Name: SHAREDvector.cpp/.hpp
File Description: SHARED vector
File Function List
-
- calculateRotationVectorFromDeformationMatrix
- subtractVectorsRT
- addVectorsRT
- multiplyVectorByScalarRT
- copyVectorRT
- normaliseVector
- negativeVector
- dotProduct
- crossProduct
- makeMatrix
- multMatrixByVector
- createVector
- findMagnitudeOfVector
- copyVectors
- copyMatricies
- multiplyMatricies
- copyMatrixTwoIntoMatrixOne
- find2DintersectionPoint
- calcDistanceBetweenTwoPoints2D
- solve2DlineEquationWithTwoPoints
- find2DintersectionPointOfTwoLines
- twoPointsAreTheSame2D
- determineIfPointLiesOnAKnownLine2D
- compareDoublesRelaxed
- determineIfPointLiesOnAKnownLine2Drelaxed
- twoPointsAreTheSame2Drelaxed
File Diagram (functions hierarchy)
Function SHAREDvectorClass::calculateRotationVectorFromDeformationMatrix()
Function Summary
name | return type | description |
calculateRotationVectorFromDeformationMatrix | void | calculate rotation vector from deformation matrix |
Function Arguments
name | type | description |
deformationMatrix | mat* | deformation matrix |
rotationVector | vec* | rotation vector |
Function Reference List
N/A
Function SHAREDvectorClass::subtractVectorsRT()
Function Summary
name | return type | description |
subtractVectorsRT | void | subtract vectors RT |
Function Arguments
name | type | description |
vect1 | const vec* | vect 1 |
vect2 | const vec* | vect 2 |
vect | vec* | vect |
Function Reference List
N/A
Function SHAREDvectorClass::addVectorsRT()
Function Summary
name | return type | description |
addVectorsRT | void | add vectors RT |
Function Arguments
name | type | description |
vect1 | const vec* | vect 1 |
vect2 | const vec* | vect 2 |
vect | vec* | vect |
Function Reference List
N/A
Function SHAREDvectorClass::multiplyVectorByScalarRT()
Function Summary
name | return type | description |
multiplyVectorByScalarRT | void | multiply vector by scalar RT |
Function Arguments
name | type | description |
vect1 | const vec* | vect 1 |
multiplyer | const double | multiplyer |
vect | vec* | vect |
Function Reference List
N/A
Function SHAREDvectorClass::copyVectorRT()
Function Summary
name | return type | description |
copyVectorRT | void | copy vector RT |
Function Arguments
name | type | description |
vecNew | vec* | vec new |
vecToCopy | const vec* | vec to copy |
Function Reference List
N/A
Function SHAREDvectorClass::normaliseVector()
Function Summary
name | return type | description |
normaliseVector | void | normalise vector |
Function Arguments
name | type | description |
vect1 | vec* | vect 1 |
Function Reference List
Function SHAREDvectorClass::negativeVector()
Function Summary
name | return type | description |
negativeVector | void | negative vector |
Function Arguments
name | type | description |
vect1 | vec* | vect 1 |
vect | vec* | vect |
Function Reference List
N/A
Function SHAREDvectorClass::dotProduct()
Function Summary
name | return type | description |
dotProduct | double | dot product |
Function Arguments
name | type | description |
vect1 | const vec* | vect 1 |
vect2 | const vec* | vect 2 |
Function Reference List
N/A
Function SHAREDvectorClass::crossProduct()
Function Summary
name | return type | description |
crossProduct | void | cross product |
Function Arguments
name | type | description |
vect1 | vec* | vect 1 |
vect2 | vec* | vect 2 |
vect | vec* | vect |
Function Reference List
N/A
Function SHAREDvectorClass::makeMatrix()
Function Summary
name | return type | description |
makeMatrix | void | make matrix |
Function Arguments
name | type | description |
vect1 | vec* | vect 1 |
vect2 | vec* | vect 2 |
vect3 | vec* | vect 3 |
matx | mat* | matx |
Function Reference List
N/A
Function SHAREDvectorClass::multMatrixByVector()
Function Summary
name | return type | description |
multMatrixByVector | void | mult matrix by vector |
Function Arguments
name | type | description |
matx | mat* | matx |
vect1 | vec* | vect 1 |
vect | vec* | vect |
Function Reference List
N/A
Function SHAREDvectorClass::createVector()
Function Summary
name | return type | description |
createVector | void | create vector |
Function Arguments
name | type | description |
vec | vec* | vec |
Function Reference List
N/A
Function SHAREDvectorClass::findMagnitudeOfVector()
Function Summary
name | return type | description |
findMagnitudeOfVector | double | find magnitude of vector |
Function Arguments
name | type | description |
vect1 | const vec* | vect 1 |
Function Reference List
N/A
Function SHAREDvectorClass::copyVectors()
Function Summary
name | return type | description |
copyVectors | void | copy vectors |
Function Arguments
name | type | description |
vecNew | vec* | vec new |
vecToCopy | const vec* | vec to copy |
Function Reference List
N/A
Function SHAREDvectorClass::copyMatricies()
Function Summary
name | return type | description |
copyMatricies | void | copy matricies |
Function Arguments
name | type | description |
matNew | mat* | mat new |
matToCopy | const mat* | mat to copy |
Function Reference List
-
- copyVectors
- copyVectors
- copyVectors
Function SHAREDvectorClass::multiplyMatricies()
Function Summary
name | return type | description |
multiplyMatricies | void | multiply matricies |
Function Arguments
name | type | description |
matNew | mat* | mat new |
mat1 | mat* | mat 1 |
mat2 | mat* | mat 2 |
Function Reference List
N/A
Function SHAREDvectorClass::copyMatrixTwoIntoMatrixOne()
Function Summary
name | return type | description |
copyMatrixTwoIntoMatrixOne | void | copy matrix two into matrix one |
Function Arguments
name | type | description |
mat1 | mat* | mat 1 |
mat2 | mat* | mat 2 |
Function Reference List
N/A
Function SHAREDvectorClass::find2DintersectionPoint()
Function Summary
name | return type | description |
find2DintersectionPoint | void | find 2D intersection point |
Function Arguments
name | type | description |
ax | double | ax |
ay | double | ay |
bx | double | bx |
by | double | by |
cx | const double | cx |
cy | const double | cy |
dx | const double | dx |
dy | const double | dy |
intersectionX | double* | intersection X |
intersectionY | double* | intersection Y |
interceptionFound | bool* | interception found |
interceptionPointFound | bool* | interception point found |
Function Reference List
-
- twoPointsAreTheSame2D
- solve2DlineEquationWithTwoPoints
- twoPointsAreTheSame2D
- solve2DlineEquationWithTwoPoints
- find2DintersectionPointOfTwoLines
- compareDoublesRelaxed
- SHAREDvarsClass::compareDoubles
- compareDoublesRelaxed
- SHAREDvarsClass::compareDoubles
- twoPointsAreTheSame2Drelaxed
- twoPointsAreTheSame2D
- determineIfPointLiesOnAKnownLine2Drelaxed
- determineIfPointLiesOnAKnownLine2D
- compareDoublesRelaxed
- SHAREDvarsClass::compareDoubles
- determineIfPointLiesOnAKnownLine2Drelaxed
- determineIfPointLiesOnAKnownLine2D
- compareDoublesRelaxed
- SHAREDvarsClass::compareDoubles
Function SHAREDvectorClass::calcDistanceBetweenTwoPoints2D()
Function Summary
name | return type | description |
calcDistanceBetweenTwoPoints2D | double | calc distance between two points 2D |
Function Arguments
name | type | description |
x1 | const double | x1 |
y1 | const double | y1 |
x2 | const double | x2 |
y2 | const double | y2 |
Function Reference List
N/A
Function SHAREDvectorClass::solve2DlineEquationWithTwoPoints()
Function Summary
name | return type | description |
solve2DlineEquationWithTwoPoints | bool | solve 2D line equation with two points |
Function Arguments
name | type | description |
x1 | double | x1 |
y1 | double | y1 |
x2 | const double | x2 |
y2 | const double | y2 |
m | double* | m |
i | double* | i |
Function Reference List
N/A
Function SHAREDvectorClass::find2DintersectionPointOfTwoLines()
Function Summary
name | return type | description |
find2DintersectionPointOfTwoLines | bool | find 2D intersection point of two lines |
Function Arguments
name | type | description |
m1 | double | m1 |
i1 | double | i1 |
m2 | const double | m2 |
i2 | const double | i2 |
xIntersection | double* | xIntersection |
yIntersection | double* | yIntersection |
Function Reference List
N/A
Function SHAREDvectorClass::twoPointsAreTheSame2D()
Function Summary
name | return type | description |
twoPointsAreTheSame2D | bool | two points are the same 2D |
Function Arguments
name | type | description |
x1 | const double | x1 |
y1 | const double | y1 |
x2 | const double | x2 |
y2 | const double | y2 |
Function Reference List
-
- SHAREDvarsClass::compareDoubles
- calcDistanceBetweenTwoPoints2D
Function SHAREDvectorClass::determineIfPointLiesOnAKnownLine2D()
Function Summary
name | return type | description |
determineIfPointLiesOnAKnownLine2D | bool | determine if point lies on AK nown line 2D |
Function Arguments
name | type | description |
m1 | const double | m1 |
i1 | const double | i1 |
x3 | const double | x3 |
y3 | const double | y3 |
Function Reference List
-
- SHAREDvarsClass::compareDoubles
Function SHAREDvectorClass::compareDoublesRelaxed()
Function Summary
name | return type | description |
compareDoublesRelaxed | bool | compare doubles relaxed |
Function Arguments
name | type | description |
a | const double | a |
b | const double | b |
Function Reference List
N/A
Function SHAREDvectorClass::determineIfPointLiesOnAKnownLine2Drelaxed()
Function Summary
name | return type | description |
determineIfPointLiesOnAKnownLine2Drelaxed | bool | determine if point lies on AK nown line 2D relaxed |
Function Arguments
name | type | description |
m1 | const double | m1 |
i1 | const double | i1 |
x3 | const double | x3 |
y3 | const double | y3 |
Function Reference List
Function SHAREDvectorClass::twoPointsAreTheSame2Drelaxed()
Function Summary
name | return type | description |
twoPointsAreTheSame2Drelaxed | bool | two points are the same 2D relaxed |
Function Arguments
name | type | description |
x1 | const double | x1 |
y1 | const double | y1 |
x2 | const double | x2 |
y2 | const double | y2 |
Function Reference List
-
- compareDoublesRelaxed
- calcDistanceBetweenTwoPoints2D
File RTpixelMaps Documentation
File Name: RTpixelMaps.cpp/.hpp
File Description: RT pixel maps
File Function List
-
- getRGBMapValues
- setRGBMapValues
- setNormalMapValue
- getNormalMapValue
- setPointMapValue
- setVectorMapValue
- getVectorMapValue
- setLumOrContrastOrDepthMapValue
- getLumOrContrastOrDepthMapValue
- writeImage
- fillInRTRulesExternVariables
File Diagram (functions hierarchy)
Function RTpixelMapsClass::getRGBMapValues()
Function Summary
name | return type | description |
getRGBMapValues | void | get RGBM ap values |
Function Arguments
name | type | description |
x | int | x |
y | int | y |
imageWidth | int | image width |
rgbMap | uchar* | rgb map |
col | colour* | col |
Function Reference List
N/A
Function RTpixelMapsClass::setRGBMapValues()
Function Summary
name | return type | description |
setRGBMapValues | void | set RGBM ap values |
Function Arguments
name | type | description |
x | const int | x |
y | const int | y |
imageWidth | const int | image width |
col | colour* | col |
rgbMap | uchar* | rgb map |
Function Reference List
N/A
Function RTpixelMapsClass::setNormalMapValue()
Function Summary
name | return type | description |
setNormalMapValue | void | set normal map value |
Function Arguments
name | type | description |
x | const int | x |
y | const int | y |
imageWidth | const int | image width |
normalVal | vec* | normal val |
normalMap | double* | normal map |
Function Reference List
Function RTpixelMapsClass::getNormalMapValue()
Function Summary
name | return type | description |
getNormalMapValue | void | get normal map value |
Function Arguments
name | type | description |
x | int | x |
y | int | y |
imageWidth | int | image width |
normalMap | double* | normal map |
normalVal | vec* | normal val |
Function Reference List
Function RTpixelMapsClass::setPointMapValue()
Function Summary
name | return type | description |
setPointMapValue | void | set point map value |
Function Arguments
name | type | description |
x | const int | x |
y | const int | y |
imageWidth | const int | image width |
pointVal | vec* | point val |
pointMap | double* | point map |
Function Reference List
Function RTpixelMapsClass::setVectorMapValue()
Function Summary
name | return type | description |
setVectorMapValue | void | set vector map value |
Function Arguments
name | type | description |
x | const int | x |
y | const int | y |
imageWidth | const int | image width |
vectorVal | vec* | vector val |
vectorMap | double* | vector map |
Function Reference List
N/A
Function RTpixelMapsClass::getVectorMapValue()
Function Summary
name | return type | description |
getVectorMapValue | void | get vector map value |
Function Arguments
name | type | description |
x | int | x |
y | int | y |
imageWidth | int | image width |
vectorMap | double* | vector map |
vectorVal | vec* | vector val |
Function Reference List
N/A
Function RTpixelMapsClass::setLumOrContrastOrDepthMapValue()
Function Summary
name | return type | description |
setLumOrContrastOrDepthMapValue | void | set lum or contrast or depth map value |
Function Arguments
name | type | description |
x | const int | x |
y | const int | y |
imageWidth | const int | image width |
contrastVal | double | contrast val |
contrastMap | double* | contrast map |
Function Reference List
N/A
Function RTpixelMapsClass::getLumOrContrastOrDepthMapValue()
Function Summary
name | return type | description |
getLumOrContrastOrDepthMapValue | double | get lum or contrast or depth map value |
Function Arguments
name | type | description |
x | const int | x |
y | const int | y |
imageWidth | const int | image width |
contrastMap | const double* | contrast map |
Function Reference List
N/A
Function RTpixelMapsClass::writeImage()
Function Summary
name | return type | description |
writeImage | void | write image |
Function Arguments
name | type | description |
imageFileName | const string | image file name |
pm | pixmap* | pm |
Function Reference List
-
- RTppmClass::writePPM
- RTppmClass::freePixmap
Function RTpixelMapsClass::fillInRTRulesExternVariables()
Function Summary
name | return type | description |
fillInRTRulesExternVariables | void | fill in RTR ules extern variables |
Function Reference List
N/A
File RTppm Documentation
File Name: RTppm.cpp/.hpp
File Description: RT ppm
File Function List
-
- placepointPPM
- newPixmap
- writePPM
- freePixmap
File Diagram (functions hierarchy)
Function RTppmClass::placepointPPM()
Function Summary
name | return type | description |
placepointPPM | void | placepoint PPM |
Function Arguments
name | type | description |
pm | pixmap* | pm |
x | const int | x |
y | const int | y |
r | int | r |
g | int | g |
b | int | b |
Function Reference List
N/A
Function RTppmClass::newPixmap()
Function Summary
name | return type | description |
newPixmap | pixmap* | new pixmap |
Function Arguments
name | type | description |
wide | const int | wide |
high | const int | high |
Function Reference List
N/A
Function RTppmClass::writePPM()
Function Summary
name | return type | description |
writePPM | void | write PPM |
Function Arguments
name | type | description |
fname | const string | fname |
pm | const pixmap* | pm |
Function Reference List
N/A
Function RTppmClass::freePixmap()
Function Summary
name | return type | description |
freePixmap | void | free pixmap |
Function Arguments
name | type | description |
pm | pixmap* | pm |
Function Reference List
N/A
File LDparser Documentation
File Name: LDparser.cpp/.hpp
File Description: LD parser
File Function List
-
- parseFile
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- removeWhiteSpaceFromString
File Diagram (functions hierarchy)
Function LDparserClass::parseFile()
Function Summary
name | return type | description |
parseFile | bool | parse file |
Function Arguments
name | type | description |
parseFileName | string | parse file name |
initialReference | LDreference* | initial reference |
parentReference | LDreference* | parent reference |
recurseIntoPartsDir | const bool | recurse into parts dir |
Function Reference List
-
-
-
- removeWhiteSpaceFromString
- removeWhiteSpaceFromString
-
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvarsClass::convertStringToDouble
- SHAREDvectorClass::multiplyMatricies
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- SHAREDvectorClass::multiplyMatricies
- calcModXPosBasedUponRotate
- calcModYPosBasedUponRotate
- calcModZPosBasedUponRotate
- parseFile
Function LDparserClass::calcModXPosBasedUponRotate()
Function Summary
name | return type | description |
calcModXPosBasedUponRotate | double | calc mod XP os based upon rotate |
Function Arguments
name | type | description |
childRelativePosition | const vec* | child relative position |
parentReferenceDeformationMatrix | const mat* | parent reference deformation matrix |
Function Reference List
N/A
Function LDparserClass::calcModYPosBasedUponRotate()
Function Summary
name | return type | description |
calcModYPosBasedUponRotate | double | calc mod YP os based upon rotate |
Function Arguments
name | type | description |
childRelativePosition | const vec* | child relative position |
parentReferenceDeformationMatrix | const mat* | parent reference deformation matrix |
Function Reference List
N/A
Function LDparserClass::calcModZPosBasedUponRotate()
Function Summary
name | return type | description |
calcModZPosBasedUponRotate | double | calc mod ZP os based upon rotate |
Function Arguments
name | type | description |
childRelativePosition | const vec* | child relative position |
parentReferenceDeformationMatrix | const mat* | parent reference deformation matrix |
Function Reference List
N/A
Function LDparserClass::removeWhiteSpaceFromString()
Function Summary
name | return type | description |
removeWhiteSpaceFromString | string | remove white space from string |
Function Arguments
name | type | description |
s | const string | s |
Function Reference List
N/A
File RTreferenceManipulation Documentation
File Name: RTreferenceManipulation.cpp/.hpp
File Description: RT reference manipulation
File Function List
-
- write2DReferenceListCollapsedTo1DToFileRayTraceFormat
- writeRayTraceFormatHeaderInfo
- write2DReferencesLayerToFileObjectRayTraceFormat
- addReferenceToFileObjectRayTraceFormat
File Diagram (functions hierarchy)
Function RTreferenceManipulationClass::write2DReferenceListCollapsedTo1DToFileRayTraceFormat()
Function Summary
name | return type | description |
write2DReferenceListCollapsedTo1DToFileRayTraceFormat | bool | write 2DR eference list collapsed to 1DT o file ray trace format |
Function Arguments
name | type | description |
fileName | string | file name |
firstReference | LDreference* | first reference |
useCustomViewInfo | const bool | use custom view info |
vi | const RTviewInfo* | vi |
useCustomLightSource | const bool | use custom light source |
lightSourcePosition | const vec* | light source position |
lightSourceColour | const string | light source colour |
Function Reference List
-
-
- writeRayTraceFormatHeaderInfo
- write2DReferencesLayerToFileObjectRayTraceFormat
Function RTreferenceManipulationClass::writeRayTraceFormatHeaderInfo()
Function Summary
name | return type | description |
writeRayTraceFormatHeaderInfo | bool | write ray trace format header info |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
useCustomViewInfo | const bool | use custom view info |
vi | const RTviewInfo* | vi |
useCustomLightSource | const bool | use custom light source |
lightSourcePosition | const vec* | light source position |
lightSourceColour | const string | light source colour |
Function Reference List
-
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
Function RTreferenceManipulationClass::write2DReferencesLayerToFileObjectRayTraceFormat()
Function Summary
name | return type | description |
write2DReferencesLayerToFileObjectRayTraceFormat | bool | write 2DR eferences layer to file object ray trace format |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
firstReferenceInLayer | LDreference* | first reference in layer |
Function Reference List
-
-
-
- write2DReferencesLayerToFileObjectRayTraceFormat
- LDreferenceManipulationClass::copyReferences
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyMatricies
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- addReferenceToFileObjectRayTraceFormat
Function RTreferenceManipulationClass::addReferenceToFileObjectRayTraceFormat()
Function Summary
name | return type | description |
addReferenceToFileObjectRayTraceFormat | bool | add reference to file object ray trace format |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
currentReference | LDreference* | current reference |
Function Reference List
-
-
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- SHAREDvectorClass::calculateRotationVectorFromDeformationMatrix
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- LDreferenceManipulationClass::convertPositionCoordinatesToString
- SHAREDvarsClass::compareDoubles
- SHAREDvarsClass::compareDoubles
- SHAREDvarsClass::compareDoubles
- RToperationsClass::makeAdvancedMatrix
- RToperationsClass::createInverseRotationxMatrix
- RToperationsClass::createInverseRotationyMatrix
- RToperationsClass::createInverseRotationzMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
- RToperationsClass::multAdvancedMatrix
File LDreferenceManipulation Documentation
File Name: LDreferenceManipulation.cpp/.hpp
File Description: LD reference manipulation
File Function List
-
- copyReferences
- convertPositionCoordinatesToString
- addReferenceToFileObject
- convertRotationMatrixToString
- write2DreferenceListCollapsedTo1DtoFile
- write2DreferencesLayerToFileObject
File Diagram (functions hierarchy)
Function LDreferenceManipulationClass::copyReferences()
Function Summary
name | return type | description |
copyReferences | void | copy references |
Function Arguments
name | type | description |
referenceNew | LDreference* | reference new |
referenceToCopy | LDreference* | reference to copy |
type | const int | type |
Function Reference List
-
-
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyMatricies
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
Function LDreferenceManipulationClass::convertPositionCoordinatesToString()
Function Summary
name | return type | description |
convertPositionCoordinatesToString | string | convert position coordinates to string |
Function Arguments
name | type | description |
spriteSceneCoords | const vec* | sprite scene coords |
Function Reference List
-
- SHAREDvarsClass::sprintfSafeDouble
- SHAREDvarsClass::sprintfSafeDouble
- SHAREDvarsClass::sprintfSafeDouble
Function LDreferenceManipulationClass::addReferenceToFileObject()
Function Summary
name | return type | description |
addReferenceToFileObject | bool | add reference to file object |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
currentReference | LDreference* | current reference |
Function Reference List
-
-
- SHAREDvarsClass::convertIntToString
- SHAREDvarsClass::convertUnsignedIntToString
- convertPositionCoordinatesToString
- SHAREDvectorClass::copyMatrixTwoIntoMatrixOne
- convertRotationMatrixToString
- convertPositionCoordinatesToString
- convertPositionCoordinatesToString
- convertPositionCoordinatesToString
- convertPositionCoordinatesToString
Function LDreferenceManipulationClass::convertRotationMatrixToString()
Function Summary
name | return type | description |
convertRotationMatrixToString | string | convert rotation matrix to string |
Function Arguments
name | type | description |
rotationMatrix | const mat* | rotation matrix |
Function Reference List
-
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
- SHAREDvarsClass::convertDoubleToString
Function LDreferenceManipulationClass::write2DreferenceListCollapsedTo1DtoFile()
Function Summary
name | return type | description |
write2DreferenceListCollapsedTo1DtoFile | bool | write 2D reference list collapsed to 1D to file |
Function Arguments
name | type | description |
fileName | const string | file name |
firstReference | LDreference* | first reference |
Function Reference List
-
- write2DreferencesLayerToFileObject
Function LDreferenceManipulationClass::write2DreferencesLayerToFileObject()
Function Summary
name | return type | description |
write2DreferencesLayerToFileObject | bool | write 2D references layer to file object |
Function Arguments
name | type | description |
writeFileObject | ofstream* | write file object |
firstReferenceInLayer | LDreference* | first reference in layer |
Function Reference List
-
-
-
- write2DreferencesLayerToFileObject
- copyReferences
- SHAREDvectorClass::copyMatricies
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors
- SHAREDvectorClass::copyVectors