VueGL

# <vgl-grid-helper>

A basic object representation.

# Example Usage

<template>
  <div>
    <vgl-renderer antialias>
      <template #scene>
        <vgl-scene>
          <vgl-grid-helper
            :size="size"
            :divisions="divisions"
            :color-center-line="colorCenterLine"
            :color-grid="colorGrid"
          />
        </vgl-scene>
      </template>
      <template #camera>
        <vgl-perspective-camera
          position="spherical"
          :position-radius="15"
          :position-phi="1"
          :position-theta="0.5"
          rotation="lookAt"
        />
      </template>
    </vgl-renderer>

    <aside class="control-panel">
      <section>
        <h3>Grid</h3>
        <label>Size<input
          v-model.number="size"
          type="range"
          max="20"
        ></label>
        <label>Divisions<input
          v-model.number="divisions"
          type="range"
          step="2"
        ></label>
      </section>
      <section>
        <h3>Centerline color</h3>
        <label>R<input
          v-model="cr"
          type="range"
          max="255"
        ></label>
        <label>G<input
          v-model="cg"
          type="range"
          max="255"
        ></label>
        <label>B<input
          v-model="cb"
          type="range"
          max="255"
        ></label>
      </section>
      <section>
        <h3>Grid color</h3>
        <label>R<input
          v-model="gr"
          type="range"
          max="255"
        ></label>
        <label>G<input
          v-model="gg"
          type="range"
          max="255"
        ></label>
        <label>B<input
          v-model="gb"
          type="range"
          max="255"
        ></label>
      </section>
    </aside>
  </div>
</template>

<script>
import * as components from 'vue-gl';

export default {
  components,
  data: () => ({
    size: 10,
    divisions: 10,
    cr: '255',
    cg: '0',
    cb: '0',
    gr: '255',
    gg: '255',
    gb: '255',
  }),
  computed: {
    colorCenterLine() { return `rgb(${this.cr}, ${this.cg}, ${this.cb})`; },
    colorGrid() { return `rgb(${this.gr}, ${this.gg}, ${this.gb})`; },
  },
};
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

# Props

  • position : 'rectangular' | 'spherical'
    The coodinate system to determine the object position.
    Defaults to [object Object]
  • positionX : number
    The x coordinate of the object's local position.
    Defaults to [object Object]
  • positionY : number
    The y coordinate of the object's local position.
    Defaults to [object Object]
  • positionZ : number
    The z coordinate of the object's local position.
    Defaults to [object Object]
  • positionRadius : number
    The Euclidian distance from the origin to the object's local position.
    Defaults to [object Object]
  • positionPhi : number
    The polar angle from y axis to the object's local position.
    Defaults to [object Object]
  • positionTheta : number
    The equator angle around y axis to the object's local position.
    Defaults to [object Object]
  • rotation : 'euler' | 'quaternion' | 'lookAt'
    The rotation representing method.
    Defaults to [object Object]
  • rotationX : number
    The x coordinate of the object's local rotation.
    Defaults to [object Object]
  • rotationY : number
    The y coordinate of the object's local rotation.
    Defaults to [object Object]
  • rotationZ : number
    The z coordinate of the object's local rotation.
    Defaults to [object Object]
  • rotationW : number
    The w coordinate of the object's local rotation.
    Defaults to [object Object]
  • rotationOrder : string
    The rotation order of the object's local rotation.
    Defaults to [object Object]
  • lookAtX : number
    The global x coodinate of a point the object to face.
    Defaults to [object Object]
  • lookAtY : number
    The global y coodinate of a point the object to face.
    Defaults to [object Object]
  • lookAtZ : number
    The global z coodinate of a point the object to face.
    Defaults to [object Object]
  • scaleX : number
    The x coordinate of the object's local scale.
    Defaults to [object Object]
  • scaleY : number
    The y coordinate of the object's local scale.
    Defaults to [object Object]
  • scaleZ : number
    The z coordinate of the object's local scale.
    Defaults to [object Object]
  • castShadow : boolean
    Whether the object gets rendered into the shadow map.
  • receiveShadow : boolean
    Whether the material receives shadows.
  • name : string
    An arbitrary name of the instance.
    Defaults to [object Object]
  • hidden : boolean
    The object visibility.
  • size : number
    The size of the grid.
    Defaults to [object Object]
  • divisions : number
    The number of grid divisions.
    Defaults to [object Object]
  • colorCenterLine : string|number
    The color of the center line.
    Defaults to [object Object]
  • colorGrid : string|number
    The color of grid lines.
    Defaults to [object Object]

# Slots

  • default
    Objects defined in the slot will be handled as decsendants.

← <vgl-polar-grid-helper> →