java.lang.Object
- nl.harm27.obswebsocket.api.complex.SceneItemTransform

public class SceneItemTransform
extends Object

See Also:: OBS WebSocket Documentation

Constructor Summary

Constructors
Constructor Description

SceneItemTransform()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`int`	`getBoundsAlignment()`	Alignment of the bounding box.
`BoundsType`	`getBoundsType()`	Type of bounding box.
`double`	`getBoundsX()`	Width of the bounding box.
`double`	`getBoundsY()`	Height of the bounding box.
`int`	`getCropBottom()`	The number of pixels cropped off the bottom of the scene item before scaling.
`int`	`getCropLeft()`	The number of pixels cropped off the left of the scene item before scaling.
`int`	`getCropRight()`	The number of pixels cropped off the right of the scene item before scaling.
`int`	`getCropTop()`	The number of pixels cropped off the top of the scene item before scaling.
`Optional<List<SceneItemTransform>>`	`getGroupChildren()`	List of children (if this item is a group).
`double`	`getHeight()`	Scene item height (base source height multiplied by the vertical scaling factor).
`Optional<String>`	`getParentGroupName()`	Name of the item's parent (if this item belongs to a group).
`int`	`getPositionAlignment()`	The point on the scene item that the item is manipulated from.
`int`	`getPositionX()`	The x position of the scene item from the left.
`int`	`getPositionY()`	The y position of the scene item from the top.
`double`	`getRotation()`	The clockwise rotation of the scene item in degrees around the point of alignment.
`double`	`getScaleX()`	The x-scale factor of the scene item.
`double`	`getScaleY()`	The y-scale factor of the scene item.
`int`	`getSourceHeight()`	Base source (without scaling) of the source.
`int`	`getSourceWidth()`	Base width (without scaling) of the source.
`double`	`getWidth()`	Scene item width (base source width multiplied by the horizontal scaling factor).
`boolean`	`isLocked()`	If the scene item is locked in position.
`boolean`	`isVisible()`	If the scene item is visible.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SceneItemTransform
```
public SceneItemTransform()
```
- Method Detail
  - getPositionX
```
public int getPositionX()
```
    The x position of the scene item from the left.
  - getPositionY
```
public int getPositionY()
```
    The y position of the scene item from the top.
  - getPositionAlignment
```
public int getPositionAlignment()
```
    The point on the scene item that the item is manipulated from.
  - getRotation
```
public double getRotation()
```
    The clockwise rotation of the scene item in degrees around the point of alignment.
  - getScaleX
```
public double getScaleX()
```
    The x-scale factor of the scene item.
  - getScaleY
```
public double getScaleY()
```
    The y-scale factor of the scene item.
  - getCropTop
```
public int getCropTop()
```
    The number of pixels cropped off the top of the scene item before scaling.
  - getCropRight
```
public int getCropRight()
```
    The number of pixels cropped off the right of the scene item before scaling.
  - getCropBottom
```
public int getCropBottom()
```
    The number of pixels cropped off the bottom of the scene item before scaling.
  - getCropLeft
```
public int getCropLeft()
```
    The number of pixels cropped off the left of the scene item before scaling.
  - isVisible
```
public boolean isVisible()
```
    If the scene item is visible.
  - isLocked
```
public boolean isLocked()
```
    If the scene item is locked in position.
  - getBoundsType
```
public BoundsType getBoundsType()
```
    Type of bounding box. Can be "OBS_BOUNDS_STRETCH", "OBS_BOUNDS_SCALE_INNER", "OBS_BOUNDS_SCALE_OUTER", "OBS_BOUNDS_SCALE_TO_WIDTH", "OBS_BOUNDS_SCALE_TO_HEIGHT", "OBS_BOUNDS_MAX_ONLY" or "OBS_BOUNDS_NONE".
  - getBoundsAlignment
```
public int getBoundsAlignment()
```
    Alignment of the bounding box.
  - getBoundsX
```
public double getBoundsX()
```
    Width of the bounding box.
  - getBoundsY
```
public double getBoundsY()
```
    Height of the bounding box.
  - getSourceWidth
```
public int getSourceWidth()
```
    Base width (without scaling) of the source.
  - getSourceHeight
```
public int getSourceHeight()
```
    Base source (without scaling) of the source.
  - getWidth
```
public double getWidth()
```
    Scene item width (base source width multiplied by the horizontal scaling factor).
  - getHeight
```
public double getHeight()
```
    Scene item height (base source height multiplied by the vertical scaling factor).
  - getParentGroupName
```
public Optional<String> getParentGroupName()
```
    Name of the item's parent (if this item belongs to a group).
  - getGroupChildren
```
public Optional<List<SceneItemTransform>> getGroupChildren()
```
    List of children (if this item is a group).

Class SceneItemTransform

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SceneItemTransform

Method Detail

getPositionX

getPositionY

getPositionAlignment

getRotation

getScaleX

getScaleY

getCropTop

getCropRight

getCropBottom

getCropLeft

isVisible

isLocked

getBoundsType

getBoundsAlignment

getBoundsX

getBoundsY

getSourceWidth

getSourceHeight

getWidth

getHeight

getParentGroupName

getGroupChildren