vrdSceneplateNode

class vrdSceneplateNode

(Inherits vrdNode)

Base class for all scene plate types.

Holds all properties for front and back plates. Allow changes and queries. Query methods have get suffix, change methods have set suffix.

Summary

Functions:

Functions

vrdSceneplateNode.getBackgroundColor()

Returns the text background color.

Returns:3D floating point vector for RGB value
Return type:QVector3D
vrdSceneplateNode.getBackgroundTransparency()

Returns the transparency of the text background.

Returns:Background transparency
Return type:float
vrdSceneplateNode.getBrightness()

Returns brightness from color correction.

Returns:Brightness
Return type:float
vrdSceneplateNode.getClickThrough()

Returns the transparency limit for content to be unnoticeable to mouse clicks.

Returns:Floating number between 0 and 1
Return type:float
vrdSceneplateNode.getContentType()

Returns the type of content to be displayed on the plate.

Returns:Content type
Return type:vrSceneplateTypes.ContentType
vrdSceneplateNode.getContrast()

Returns contrast from color correction.

Returns:Contrast
Return type:float
vrdSceneplateNode.getFont()

Returns font name.

Returns:Font name
Return type:string
vrdSceneplateNode.getFontColor()

Returns the font color.

Returns:3D floating point vector of for RGB value
Return type:QVector3D
vrdSceneplateNode.getFontHeight()

Returns the vertical resolution in pixels per text line.

Returns:Font height in pixel
Return type:integer
vrdSceneplateNode.getFontStyle()

Returns text font style.

Returns:Font style, e.g. “Bold”, “Italic”
Return type:string
vrdSceneplateNode.getFrameOffset()

Returns offset to the image number when using an image sequence.

Returns:Frame offset
Return type:integer
vrdSceneplateNode.getHeight()

Returns the height of the canvas in pixels for HTML content.

Returns:Height
Return type:integer
vrdSceneplateNode.getHueShift()

Returns hue shift from color correction.

Returns:Floating value starts on zero
Return type:float
vrdSceneplateNode.getImage()

Returns the image object.

Returns:Image
Return type:vrdImage
vrdSceneplateNode.getImageNumber()

Returns image number in current image sequence.

Returns:Image number
Return type:integer
vrdSceneplateNode.getInlineImageSequence()

Returns if image sequence is inlined into the vpb file.

Returns:True, if inlined
Return type:bool
vrdSceneplateNode.getNodeType()

Returns the node type.

Returns:Node type
Return type:vrSceneplateTypes.NodeType
vrdSceneplateNode.getOffset()

Returns the offset of the plate to its anchor point.

Returns:Offset
Return type:QVector2D
vrdSceneplateNode.getOffsetMode()

Returns how offset should be interpreted. Absolute means the offset is in pixels. Relative means the offset is given as a fraction of the viewport extents.

Returns:Offset mode
Return type:vrSceneplateTypes.SizeType
vrdSceneplateNode.getPosition()

Returns the anchor point of the plate within the viewport.

Returns:Position
Return type:vrSceneplateTypes.Position
vrdSceneplateNode.getRepeatMode()

Returns the repeat mode of the plate image within the viewport.

Returns:Repeat mode
Return type:vrSceneplateTypes.RepeatMode
vrdSceneplateNode.getRotation()

Returns the amount the plate is rotated clockwise in degrees around its center.

Returns:Rotation in degree
Return type:float
vrdSceneplateNode.getSaturation()

Returns saturation from color correction.

Returns:Saturation
Return type:float
vrdSceneplateNode.getSize()

Returns the height of the plate.

Returns:
Return type:float
vrdSceneplateNode.getSizeMode()

Returns how size is interpreted. Absolute means the size is in pixels. Relative means the size is a fraction of the viewport height.

Returns:Size mode
Return type:vrSceneplateTypes.SizeType
vrdSceneplateNode.getText()

Returns the text.

Returns:UTF-8 String
Return type:string
vrdSceneplateNode.getTransparency()

Returns the overall transparency of the plate.

Returns:Transparency
Return type:float
vrdSceneplateNode.getUrl()

Returns the url or the content of a web site.

Returns:Url or html content as string
Return type:string
vrdSceneplateNode.getUseImageSequence()

Returns if image sequences is used.

Returns:True if image sequence is use
Return type:bool
vrdSceneplateNode.getWebStreamActive()

Returns active state of the web-engine stream.

Returns:True if On, Flase if Off
Return type:bool
vrdSceneplateNode.getWhiteBalance()

Returns white balance from color correction.

Returns:White balance
Return type:integer
vrdSceneplateNode.getWidth()

Returns the width of the canvas in pixels for HTML content.

Returns:Width
Return type:integer
vrdSceneplateNode.setBackgroundColor(color)

Sets the text background color.

Parameters:color (QVector3D) – 3D floating point vector of for RGB value
vrdSceneplateNode.setBackgroundTransparency(transparency)

Sets the transparency of the text background.

Parameters:transparency (float) – Background transparency
vrdSceneplateNode.setBrightness(brightness)

Shifts the content’s blacks, grays, and whites. Higher values increase the perceived luminance of the content.

Parameters:brightness (float) – Brightness
vrdSceneplateNode.setClickThrough(clickThrough)

Sets the transparency limit for content to be unnoticeable to mouse clicks.

Parameters:clickThrough (float) – Floating number between 0 and 1
vrdSceneplateNode.setContentType(contentType)

Sets the type of content to be displayed on the plate.

Parameters:contentType (vrSceneplateTypes.ContentType) – Content type
vrdSceneplateNode.setContrast(contrast)

Shifts the content’s light and dark color values. Higher values create brighter highlights and darker shadows.

Parameters:contrast (float) – Contrast
vrdSceneplateNode.setFont(fontName)

Sets the text font.

Parameters:fontName (string) – Font name
vrdSceneplateNode.setFontColor(color)

Sets the text color.

Parameters:color (QVector3D) – 3D floating point vector for RGB value
vrdSceneplateNode.setFontHeight(fontHeight)

Sets the vertical resolution in pixels per text line.

Parameters:fontHeight (integer) – Font height in pixel
vrdSceneplateNode.setFontStyle(style)

Sets text font style.

Parameters:style (string) – Font style name, e.g. “Bold”, “Italic”
vrdSceneplateNode.setFrameOffset(frameOffset)

Sets an offset to the image number when using an image sequence.

Parameters:frameOffset (integer) – Frame offset
vrdSceneplateNode.setHeight(height)

Sets the height of the canvas in pixels for HTML content.

Parameters:height (integer) – Height
vrdSceneplateNode.setHueShift(value)

Shifts all content colors uniformly through the hue color range.

Parameters:value (float) – Floating value starts on zero
vrdSceneplateNode.setImage(img)

Sets image object.

Parameters:img (vrdImage) – Image
vrdSceneplateNode.setImageNumber(imageNumber)

Sets the image number in current image sequence.

Parameters:imageNumber (integer) – Integer number
vrdSceneplateNode.setInlineImageSequence(inlineImageSequence)

Inlines the image sequence into the vpb file.

Parameters:inlineImageSequence (bool) – True, to inline image sequence
vrdSceneplateNode.setNodeType(nodeType)

Sets the sceneplate type. Frontplates appear on top of the scene and backplates behind.

Parameters:nodeType (vrSceneplateTypes.NodeType) – Node type
vrdSceneplateNode.setOffset(offset)

Sets the offset of the plate to its anchor point.

Parameters:offset (QVector2D) – Offset
vrdSceneplateNode.setOffsetMode(offsetMode)

Sets how offset should be interpreted. Absolute means the offset is in pixels. Relative means the offset is given as a fraction of the viewport extents.

Parameters:offsetMode (vrSceneplateTypes.SizeType) – Offset mode
vrdSceneplateNode.setPosition(position)

Sets the anchor point of the plate within the viewport.

Parameters:position (vrSceneplateTypes.Position) – Position
vrdSceneplateNode.setRepeatMode(repeatMode)

Sets the repeat mode of the plate image within the viewport.

Parameters:repeatMode (vrSceneplateTypes.RepeatMode) – Repeat Mode
vrdSceneplateNode.setRotation(rotation)

Sets the amount the plate is rotated clockwise in degrees around its center.

Parameters:rotation (float) – Rotation in degree
vrdSceneplateNode.setSaturation(saturation)

Shifts the content’s color intensity. Higher values produce vivid colors. Lower values produce dull grayer colors.

Parameters:saturation (float) – Saturation
vrdSceneplateNode.setSize(size)

Sets the height of the plate. Width is set accordingly to maintain the aspect ratio of its content.

Parameters:size (float) – Size
vrdSceneplateNode.setSizeMode(sizeMode)

Sets how size is interpreted. Absolute means the size is in pixels. Relative means the size is a fraction of the viewport height.

Parameters:sizeMode (vrSceneplateTypes.SizeType) – Size mode
vrdSceneplateNode.setText(text)

Sets the text.

Parameters:text (string) – UTF-8 string
vrdSceneplateNode.setTransparency(transparency)

Sets the overall transparency of the plate.

Parameters:transparency (float) – Transparency
vrdSceneplateNode.setUrl(url)

The url can contain a valid URL to a website (‘ http://www.autodesk.com’) or the html content of a website as a string.

Parameters:url (string) – A url or html content as string
vrdSceneplateNode.setUseImageSequence(useImageSequence)

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:useImageSequence (bool) – True to use image sequence
vrdSceneplateNode.setWebStreamActive(value)

Activates/Deactivates the stream of the web-engine.

Parameters:value (bool) – True = On, False = Off
vrdSceneplateNode.setWhiteBalance(whiteBalance)

Shifts the content’s white balance to match the color temperature of the scene in Kelvin. Lower values produce cooler (bluish) colors. Higher values produce warmer (yellowish) colors.

Parameters:whiteBalance (integer) – White balance between 1000 and 15000
vrdSceneplateNode.setWidth(width)

Sets the width of the canvas in pixels for HTML content.

Parameters:width (integer) – Width