vrdLightTexture¶
-
class
vrdLightTexture¶
(Inherits vrdSceneObject)
This class represents a texture that can be projected by a light source into the scene.
This is not available for directional and ray lights.
Summary¶
- Functions:
- getAnisotropy() → float
- getConnectRepeatModes() → bool
- getFrameOffset() → integer
- getImage() → vrdImage
- getInlineImageSequence() → bool
- getOffset() → QVector2D
- getRepeat() → QVector2D
- getRepeatModeU() → vrTextureTypes.RepeatMode
- getRepeatModeV() → vrTextureTypes.RepeatMode
- getRotate() → float
- getUseImageSequence() → bool
- getUseTexture() → bool
- setAnisotropy(anisotropy)
- setConnectRepeatModes(connected)
- setFrameOffset(offset)
- setImage(img)
- setInlineImageSequence(use)
- setOffset(offset)
- setRepeat(repeat)
- setRepeatModeU(mode)
- setRepeatModeV(mode)
- setRotate(rotate)
- setUseImageSequence(use)
- setUseTexture(s)
Functions¶
-
vrdLightTexture.getAnisotropy()¶ Returns the anisotropy value of the texture.
Returns: The anisotropy value. Return type: float
-
vrdLightTexture.getConnectRepeatModes()¶ Returns whether the repeat modes for U and V are connected.
Returns: True if connected, False otherwise. Return type: bool
-
vrdLightTexture.getFrameOffset()¶ Returns the offset to the image number when using an image sequence.
Returns: Offset Return type: integer
-
vrdLightTexture.getImage()¶ Returns the image that is used as a texture.
Returns: Return type: vrdImage
-
vrdLightTexture.getInlineImageSequence()¶ Returns if the image sequence is inlined into the vpb file.
Returns: True if inlined, False otherwise. Return type: bool
-
vrdLightTexture.getOffset()¶ Returns the offset for the UVs.
Returns: The offset for the Uvs. Return type: QVector2D
-
vrdLightTexture.getRepeat()¶ Returns the number of repetitions for the UVs.
Returns: The number of repetitions. Return type: QVector2D
-
vrdLightTexture.getRepeatModeU()¶ Returns the repeat mode of the texture.
Returns: Repeat mode of the texture. Return type: vrTextureTypes.RepeatMode
-
vrdLightTexture.getRepeatModeV()¶ Returns the repeat mode of the texture.
Returns: Repeat mode of the texture. Return type: vrTextureTypes.RepeatMode
-
vrdLightTexture.getRotate()¶ Returns the texture rotation.
Returns: The rotation angle in degrees. Return type: float
-
vrdLightTexture.getUseImageSequence()¶ Returns if image sequences is used.
Returns: True if image sequence is use Return type: bool
-
vrdLightTexture.getUseTexture()¶ Returns whether the light texture is enabled.
Returns: True if enabled, False if disabled. Return type: bool
-
vrdLightTexture.setAnisotropy(anisotropy)¶ Sets the anisotropy value of the texture.
Parameters: anisotropy (float) – The anisotropy value.
-
vrdLightTexture.setConnectRepeatModes(connected)¶ Connects the repeat modes for U and V.
Parameters: connected (bool) – True to connect the repeat modes, False to disconnect.
-
vrdLightTexture.setFrameOffset(offset)¶ Sets an offset to the image number when using an image sequence.
Parameters: offset (integer) – Offset
-
vrdLightTexture.setImage(img)¶ Sets the image that should be used as a texture.
Parameters: img (vrdImage) – Image
-
vrdLightTexture.setInlineImageSequence(use)¶ Inlines the image sequence into the vpb file.
Parameters: use (bool) – If set to true, the image sequence will be inlined
-
vrdLightTexture.setOffset(offset)¶ Sets the offset for the UVs.
Parameters: offset (QVector2D) – The offset for the UVs.
-
vrdLightTexture.setRepeat(repeat)¶ Sets the number of repetitions for the UVs.
Parameters: repeat (QVector2D) – The number of repetitions.
-
vrdLightTexture.setRepeatModeU(mode)¶ Sets the repeat mode of the texture.
Parameters: mode (vrTextureTypes.RepeatMode) – Repeat mode of the texture.
-
vrdLightTexture.setRepeatModeV(mode)¶ Sets the repeat mode of the texture.
Parameters: mode (vrTextureTypes.RepeatMode) – Repeat mode of the texture.
-
vrdLightTexture.setRotate(rotate)¶ Rotate the texture.
Parameters: rotate (float) – The rotation angle in degrees.
-
vrdLightTexture.setUseImageSequence(use)¶ Use an image sequence.
Uses an image sequence as a texture. The image name for the sequence will be generated based on the filename and the image number. Use the CurveEditor to animate the image number.
Parameters: use (bool) – True to use image sequence
-
vrdLightTexture.setUseTexture(s)¶ Enables / disables the usage of the texture.
Parameters: s (bool) – True to enable, False to disable the texture.