User Tools

Site Tools


hpl3:community:scripting:classes:clensflare

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

hpl3:community:scripting:classes:clensflare [2015/11/05 12:14] (current)
abion47 created
Line 1: Line 1:
 +=====cLensFlare=====
 +
 +====Fields====
 +
 +cLensFlare has no public fields.
 +
 +====Functions====
 +
 +^ Return Type ^ Function Name ^ Parameters ^ Description ^
 +| [[eEntityType]] | GetEntityType |     ​| ​  |
 +| [[tID]] | GetID |     ​| ​  |
 +| int | GetUniqueID |     ​| ​  |
 +| void | UpdateLogic | float afTimeStep |   |
 +| const [[tString]]&​ | GetName | const |   |
 +| void | SetName | const [[tString]] &in asName |   |
 +| bool | HasParent |     ​| ​  |
 +| bool | IsActive | const |   |
 +| void | SetActive | bool abActive |   |
 +| [[cVector3f]] | GetLocalPosition |     ​| ​  |
 +| [[cMatrixf]]&​ | GetLocalMatrix |     ​| ​  |
 +| [[cVector3f]] | GetWorldPosition |     ​| ​  |
 +| [[cMatrixf]]&​ | GetWorldMatrix |     ​| ​  |
 +| void | SetPosition | const [[cVector3f]] &in avPos |   |
 +| void | SetMatrix | const [[cMatrixf]] &in a_mtxTransform |   |
 +| void | SetWorldPosition | const [[cVector3f]] &in avWorldPos |   |
 +| void | SetWorldMatrix | const [[cMatrixf]] &in a_mtxWorldTransform |   |
 +| int | GetTransformUpdateCount |     ​| ​  |
 +| [[cBoundingVolume]]@+ | GetBoundingVolume |     ​| ​  |
 +| bool | GetScriptableIsSaved |     ​| ​  |
 +| void | SetScriptableIsSaved | bool abX |   |
 +| void | AddChild | [[iEntity3D]]@ apEntity |   |
 +| void | RemoveChild | [[iEntity3D]]@ apEntity |   |
 +| bool | IsChild | [[iEntity3D]]@ apEntity |   |
 +| [[iEntity3D]]@ | GetEntityParent |     ​| ​  |
 +| [[cEntity3DIterator]]@ | GetChildIterator |     ​| ​  |
 +| const [[tString]]&​ | GetRenderName |     ​| ​  |
 +| [[cMaterial]]@ | GetMaterial |     ​| ​  |
 +| [[iVertexBuffer]]@ | GetVertexBuffer |     ​| ​  |
 +| bool | CollidesWithBV | [[cBoundingVolume]]@+ apBV |   |
 +| bool | CollidesWithFrustum | [[cFrustum]]@ apFrustum |   |
 +| [[cBoundingVolume]]@+ | GetRenderBV |     ​| ​  |
 +| [[cVector3f]] | GetWorldCenterPosition |     ​| ​  |
 +| [[eRenderableType]] | GetRenderType |     ​| ​  |
 +| void | SetRenderFlagBit | int alFlagBit, \\ bool abSet |   |
 +| bool | GetRenderFlagBit | int alFlagBit |   |
 +| int | GetRenderFlags | const |   |
 +| bool | IsStatic |     ​| ​  |
 +| bool | IsOccluder |     ​| ​  |
 +| bool | IsVisible |     ​| ​  |
 +| void | SetVisible | bool abVisible |   |
 +| bool | GetVisibleVar |     ​| ​  |
 +| void | SetIlluminationColor | const [[cColor]] &in aColor |   |
 +| const [[cColor]]&​ | GetIlluminationColor | const |   |
 +| void | SetCoverageAmount | float afX |   |
 +| float | GetCoverageAmount | const |   |
 +| int | GetMatrixUpdateCount |     ​| ​  |
 +| int | GetRenderFrameCount | const |   |
 +| void | SetRenderFrameCount | int alCount |   |
 +| void | UseAutomaticLiquidAmount | float 0 |   |
 +| void | SetLiquidAmount | float afX |   |
 +| float | GetLiquidAmount | const |   |
 +| void | FadeIn | float afTime |   |
 +| void | FadeOut | float afTime |   |
 +| void | SetFlareSourceSize | [[cVector3f]] avSize |   |
 +| [[cVector3f]] | GetFlareSourceSize |     ​| ​  |
 +| void | SetOuterFieldOfView | float afAngle |   |
 +| float | GetOuterFieldOfView |     ​| ​  |
 +| void | SetInnerFieldOfView | float afAngle |   |
 +| float | GetInnerFieldOfView |     ​| ​  |
 +| void | SetMultiIrisTextureAtlasGrid | [[cVector2l]] avMultiIrisGrid |   |
 +| [[cVector2l]] | GetMultiIrisTextureAtlasGrid |     ​| ​  |
 +| void | SetMultiIrisSeed | int alSeed |   |
 +| int | GetMultiIrisSeed |     ​| ​  |
 +| void | SetMultiIrisCount | int alCount |   |
 +| int | GetMultiIrisCount |     ​| ​  |
 +| void | SetRangeMax | float afRangeMaxStart,​ \\ float afRangeMaxEnd |   |
 +| void | DisableRangeMax |     ​| ​  |
 +| float | GetRangeMaxStart |     ​| ​  |
 +| float | GetRangeMaxEnd |     ​| ​  |
 +| void | SetRangeMin | float afRangeMinStart,​ \\ float afRangeMinEnd |   |
 +| void | DisableRangeMin |     ​| ​  |
 +| float | GetRangeMinStart |     ​| ​  |
 +| float | GetRangeMinEnd |     ​| ​  |
 +| void | SetGlareBrightness | float afBrightness |   |
 +| float | GetGlareBrightness |     ​| ​  |
 +| void | SetGlareFieldOfView | float afAngle |   |
 +| float | GetGlareFieldOfView |     ​| ​  |
 +| void | SetGlareStareAt | float afGlare |   |
 +| void | SetGlareRange | float afRangeMaxStart,​ \\ float afRangeMaxEnd |   |
 +| float | GetGlareRangeMaxStart |     ​| ​  |
 +| float | GetGlareRangeMaxEnd |     ​| ​  |
 +| void | SetSizeChangeBasedOnDistance | float afPercent |   |
 +| float | GetSizeChangeBasedOnDistance |     ​| ​  |
 +| void | SetFlareSize | [[eLensFlareType]] aType, \\ [[cVector2f]] avSize |   |
 +| [[cVector2f]] | GetFlareSize | [[eLensFlareType]] aType |   |
 +| void | SetFlareColor | [[eLensFlareType]] aType, \\ [[cColor]] aValue |   |
 +| [[cColor]] | GetFlareColor | [[eLensFlareType]] aType |   |
 +| void | SetFlareActive | [[eLensFlareType]] aType, \\ bool abValue |   |
 +| bool | IsFlareActive | [[eLensFlareType]] aType |   |
 +| void | SetUseParentMeshForOcclusion | bool abValue |   |
 +| bool | GetUseParentMeshForOcclusion |     ​| ​  |
 +| void | SetShrinkWhenOccluded | bool abValue |   |
 +| bool | GetShrinkWhenOccluded |     ​| ​  |
 +| void | SetMultiplyGlareWithMultiIris | bool abValue |   |
 +| bool | GetMultiplyGlareWithMultiIris |     ​| ​  |
 +| void | SetBrightness | float afX |   |
 +| float | GetBrightness |     ​| ​  |
 +| [[eLensFlareType]] | GetFirstActiveType |     ​| ​  |
 +| void | SetAsPointLight |     ​| ​  |
 +| void | SetMaterial | [[eLensFlareType]] aType, \\ [[cMaterial]]@ apMaterial |   |
 +
 +====Remarks====
 +
 +Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!
  
hpl3/community/scripting/classes/clensflare.txt ยท Last modified: 2015/11/05 12:14 by abion47