Unigine::ObjectVolumeOmni Class
| Header: | #include <UnigineObjects.h> |
| Inherits: | Object |
This class is used to create a volume omni object. It simulates a visible volume of light emitted from a flat light source.
The volume omni object is rendered as a flat rectangle and billboards around its edges. The rectangle simulates a light emitting surface and billboards create a light volume around it.
See Also#
A UnigineScript API sample <UnigineSDK>/data/samples/objects/volumes_03
ObjectVolumeOmni Class
Members
static ObjectVolumeOmniPtr create ( float width, float height, float radius ) #
Constructor. Creates a new volume omni object with given properties.Arguments
- float width - Width of the central rectangle in units.
- float height - Height of the central rectangle in units.
- float radius - Size of billboards in units.
static Ptr<ObjectVolumeOmni> cast ( const Ptr<Object> & base ) #
Casts an ObjectVolumeOmni out of the Object instance.Arguments
- const Ptr<Object> & base - Pointer to Object.
Return value
Pointer to ObjectVolumeOmni.static Ptr<ObjectVolumeOmni> cast ( const Ptr<Node> & node ) #
Casts an ObjectVolumeOmni out of the Node instance.Arguments
- const Ptr<Node> & node - Pointer to Node.
Return value
Pointer to ObjectVolumeOmni.void setAttenuation ( float attenuation ) #
Sets attenuation that controls how fast the volume omni object fades out when a camera looks at it from a side.Arguments
- float attenuation - Attenuation factor. If a too small value is provided, 1E-6 will be used instead.
float getAttenuation ( ) #
Returns attenuation that modulates smooth fading of the volume omni object when the camera looks at it from a side.Return value
The current attenuation factor.float getHeight ( ) #
Returns the height of the central flat rectangle in units.Return value
The height of the central rectangle in units.void setRadius ( float radius ) #
Sets the width of billboards at the edges.Arguments
- float radius - A new width in units. If a negative value is provided, 0 will be used instead.
float getRadius ( ) #
Returns the size of billboards.Return value
The size of billboards in units.void setSize ( float width, float height ) #
Sets new dimensions of the volume omni object.Arguments
- float width - A new width of the central flat rectangle in units. If a negative value is provided, 0 will be used instead.
- float height - A new height of the central flat rectangle in units. If a negative value is provided, 0 will be used instead.
float getWidth ( ) #
Returns the width of the central flat rectangle.Return value
The width of the central rectangle in units.static int type ( ) #
Returns the type of the node.Return value
Object type identifier.Last update:
2019-08-16
Help improve this article
Was this article helpful?
(or select a word/phrase and press Ctrl+Enter)