Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
ardiscript:perspective [2018/04/15 22:34] optrix |
ardiscript:perspective [2018/07/22 23:48] (current) optrix |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====Perspective==== | + | =====Perspective===== |
| - | ===Summary=== | + | ====Summary==== |
| The **perspective** function is used to move the camera so it looks at one or more assets. | The **perspective** function is used to move the camera so it looks at one or more assets. | ||
| Line 10: | Line 10: | ||
| It takes approx. 1 second for the camera to move from its current position to the new location. | It takes approx. 1 second for the camera to move from its current position to the new location. | ||
| - | ===Parameters=== | + | ====Parameters==== |
| + | |||
| + | ===Target=== | ||
| + | //Type: Text | ||
| + | Default: **everything**// | ||
| - | ==Target (string)== | ||
| Specifies the name or ARDI ID of the asset you would like to view. If using an asset ID, begin the target with the '#' character. | Specifies the name or ARDI ID of the asset you would like to view. If using an asset ID, begin the target with the '#' character. | ||
| Line 21: | Line 24: | ||
| |**all**|All assets in the scene. This normally won't include any mobile assets. See //remarks// for more details.| | |**all**|All assets in the scene. This normally won't include any mobile assets. See //remarks// for more details.| | ||
| - | ==Angle== | + | ===Angle=== |
| - | //Type: Text// | + | //Type: Text |
| - | //Default: **auto**// | + | Default: **auto**// |
| Specifies the angle from which to view the asset(s). This value should be one of the following... | Specifies the angle from which to view the asset(s). This value should be one of the following... | ||
| Line 37: | Line 40: | ||
| ==WholeObject== | ==WholeObject== | ||
| - | //Type: [[bool]]// | + | //Type: [[bool]] |
| - | //Default: **false**// | + | Default: **false**// |
| If the //target// is a sub-component of a much larger object, view the object as a whole rather than focusing on just the sub-part. | If the //target// is a sub-component of a much larger object, view the object as a whole rather than focusing on just the sub-part. | ||
| - | ==Lock== | + | ===Lock=== |
| - | //Type: [[bool]]// | + | //Type: [[bool]] |
| - | //Default: **false**// | + | Default: **false**// |
| If possible, lock the camera to the object so that the camera will move if the //target// moves. | If possible, lock the camera to the object so that the camera will move if the //target// moves. | ||
| - | ===Remarks=== | + | ===Distance=== |
| + | //Type: [[float]] | ||
| + | Default: **-1**// | ||
| + | |||
| + | The distance the camera should stop from the asset(s). | ||
| + | |||
| + | If this value is -1 (or not specified at all), the system will automatically attempt to calculate the ideal distance from the asset. | ||
| + | |||
| + | ===lroffset=== | ||
| + | //Type: [[float]] | ||
| + | Default: **20**// | ||
| + | |||
| + | ARDI will generally try to pick a location to look at the asset that is based on it's //front//. However, sometimes that's not the ideal location to view your asset from. | ||
| + | |||
| + | Left-Right Offset allows you to enter a number of degrees (from 0-360) to rotate around the asset in the left/right direction. If you find that the perspective function ends up looking at the back of the item, a lroffset value of "180" will turn you right around. | ||
| + | |||
| + | ===udoffset=== | ||
| + | //Type: [[float]] | ||
| + | Default: **20**// | ||
| + | |||
| + | ARDI will generally try to pick a location to look at the asset that is based on it's //front//. However, sometimes that's not the ideal location to view your asset from. | ||
| + | |||
| + | Up-Down Offset allows you to enter a number of degrees (from 0-360) to rotate around the asset in the up and down direction. If you find that the perspective function ends up looking at the front of the item and you'd prefer to view it from the top, you can add an udoffset of 90. | ||
| + | |||
| + | ===Children=== | ||
| + | |||
| + | //Type: [[bool]] | ||
| + | Default: **true**// | ||
| + | |||
| + | If //true//, the center and distance from the target is made up of the component itself, plus all **children** of that component. | ||
| + | |||
| + | If //false//, only the component itself is focused on - any parts within it are ignored. | ||
| + | |||
| + | ====Remarks==== | ||
| The behaviour of this function can be influenced by the [[ardieffects:autofocus]] effect. Please read the documentation on the autofocus function for more details. | The behaviour of this function can be influenced by the [[ardieffects:autofocus]] effect. Please read the documentation on the autofocus function for more details. | ||
| - | ===Examples=== | + | ====See Also==== |
| + | [[movecamera]] [[cameralookat]] | ||
| + | ====Examples==== | ||
| <code> | <code> | ||