Skip to content

Commit b4b9fa6

Browse files
pavlettopavletto
committed
change class to globe
1 parent 763e052 commit b4b9fa6

22 files changed

+153
-154
lines changed

‎README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ Example of usage:
1111
`App.tsx`
1212
```tsx
1313
import '@openglobus/openglobus-react/dist/style.css'
14-
import Globus, {GlobusContextProvider} from '@openglobus/openglobus-react'
14+
import Globus, {GlobeContextProvider} from '@openglobus/openglobus-react'
1515

1616

1717
function App() {
18-
return <GlobusContextProvider>
18+
return <GlobeContextProvider>
1919
<Globus/>
20-
</GlobusContextProvider>
20+
</GlobeContextProvider>
2121
}
2222

2323
export default App

‎src/Globe/Globe.stories.tsx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import type { Meta, StoryObj } from '@storybook/react';
22

3-
import { Globus } from './Globe';
3+
import { Globe } from './Globe';
44

55
const meta = {
6-
component: Globus,
6+
component: Globe,
77
title: 'Components/Scenes/Globe',
8-
} satisfies Meta<typeof Globus>;
8+
} satisfies Meta<typeof Globe>;
99

1010
export default meta;
1111

‎src/Globe/Globe.tsx

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from "react";
22
import {useEffect, useRef, useState} from "react";
3-
import {useGlobusContext} from "./GlobeContext";
4-
import {Globe, GlobusTerrain, utils, XYZ} from "@openglobus/og";
3+
import {useGlobeContext} from "./GlobeContext";
4+
import {Globe as GlobusGlobe, GlobusTerrain, utils, XYZ} from "@openglobus/og";
55
import {EventCallback} from "@openglobus/og/lib/js/Events";
66
import {IGlobeParams} from "@openglobus/og/lib/js/Globe";
77
import "@openglobus/og/css/og.css";
@@ -14,11 +14,11 @@ export interface GlobusProps extends IGlobeParams {
1414
onDraw?: EventCallback
1515
}
1616

17-
const Globus: React.FC<GlobusProps> = ({children, onDraw, ...rest}) => {
17+
const Globe: React.FC<GlobusProps> = ({children, onDraw, ...rest}) => {
1818
const targetRef = useRef<HTMLDivElement | null>(null);
19-
const {setGlobus} = useGlobusContext();
19+
const {setGlobe} = useGlobeContext();
2020
const [options, setOptions] = useState<IGlobeParams>(rest);
21-
const gRef = useRef<Globe | null>(null);
21+
const gRef = useRef<GlobusGlobe | null>(null);
2222
useEffect(() => {
2323
if (gRef && gRef.current && rest.atmosphereEnabled !== undefined) gRef.current.planet.atmosphereEnabled = rest.atmosphereEnabled;
2424
}, [rest.atmosphereEnabled]);
@@ -62,7 +62,7 @@ const Globus: React.FC<GlobusProps> = ({children, onDraw, ...rest}) => {
6262
return utils.stringTemplate(u, {s: this._getSubdomain(), quad: toQuadKey(s.tileX, s.tileY, s.tileZoom)});},
6363
});
6464

65-
gRef.current = new Globe({
65+
gRef.current = new GlobusGlobe({
6666
target: targetRef.current!,
6767
name: 'Earth',
6868
terrain: new GlobusTerrain(),
@@ -77,9 +77,8 @@ const Globus: React.FC<GlobusProps> = ({children, onDraw, ...rest}) => {
7777
} else {
7878
targetRef.current = gRef.current.$target as HTMLDivElement
7979
}
80-
// targetRef.current!.globus = globus;
8180

82-
setGlobus(gRef.current);
81+
setGlobe(gRef.current);
8382
return () => {
8483
if (onDraw)
8584
gRef.current?.planet.events.off('draw', onDraw)
@@ -97,4 +96,4 @@ const Globus: React.FC<GlobusProps> = ({children, onDraw, ...rest}) => {
9796
</div>
9897
);
9998
};
100-
export {Globus};
99+
export {Globe};

‎src/Globe/GlobeContext.tsx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,21 @@ import {Globe} from "@openglobus/og";
22
import * as React from "react";
33
import {createContext, useContext, useState} from "react";
44

5-
export interface GlobusContextProps {
6-
globus: Globe | null;
7-
setGlobus: React.Dispatch<React.SetStateAction<Globe | null>>;
5+
export interface GlobeContextProps {
6+
globe: Globe | null;
7+
setGlobe: React.Dispatch<React.SetStateAction<Globe | null>>;
88
}
99

10-
const GlobusContext = createContext<GlobusContextProps>({
11-
globus: null,
12-
setGlobus: () => {
10+
const GlobeContext = createContext<GlobeContextProps>({
11+
globe: null,
12+
setGlobe: () => {
1313
},
1414
});
1515

16-
export const GlobusContextProvider: React.FC<{ children: React.ReactNode }> = ({children}) => {
17-
const [globus, setGlobus] = useState<Globe | null>(null);
16+
export const GlobeContextProvider: React.FC<{ children: React.ReactNode }> = ({children}) => {
17+
const [globe, setGlobe] = useState<Globe | null>(null);
1818

19-
return <GlobusContext.Provider value={{globus: globus, setGlobus: setGlobus}}>{children}</GlobusContext.Provider>;
19+
return <GlobeContext.Provider value={{globe, setGlobe}}>{children}</GlobeContext.Provider>;
2020
};
2121

22-
export const useGlobusContext = (): GlobusContextProps => useContext(GlobusContext);
22+
export const useGlobeContext = (): GlobeContextProps => useContext(GlobeContext);

‎src/entity/Billboard/Billboard.stories.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import React from 'react';
22
import type {Meta, StoryObj} from '@storybook/react';
33

4-
import {Globus, GlobusContextProvider} from "@/Globe";
4+
import {Globe, GlobeContextProvider} from "@/Globe";
55
import {Billboard, BillboardParams, Entity} from '@/entity';
66
import {Vector} from "@/layer";
77

@@ -71,8 +71,8 @@ export const Default: Story = {
7171
offset: [0, 0, 0],
7272
visibility: true,
7373
},
74-
render: (args: BillboardParams) => <GlobusContextProvider>
75-
<Globus atmosphereEnabled={false}>
74+
render: (args: BillboardParams) => <GlobeContextProvider>
75+
<Globe>
7676
<Vector name={'test'}
7777
scaleByDistance={[6000000, 24000000, 10000000000]}>
7878
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -81,8 +81,8 @@ export const Default: Story = {
8181
/>
8282
</Entity>
8383
</Vector>
84-
</Globus>
85-
</GlobusContextProvider>
84+
</Globe>
85+
</GlobeContextProvider>
8686
};
8787

8888
export const DifferentSrc: Story = {

‎src/entity/Entity/Entity.stories.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type {Meta, StoryObj} from '@storybook/react';
22

33
import {Billboard, Entity, EntityParams} from '@/entity';
4-
import {Globus, GlobusContextProvider} from "@/Globe";
4+
import {Globe, GlobeContextProvider} from "@/Globe";
55
import {Vector} from "@/layer";
66
import React from 'react';
77

@@ -19,8 +19,8 @@ export const Default: Story = {
1919
args: {
2020
lon: 10, lat: 10, alt: 100000
2121
},
22-
render: (args: EntityParams) => <GlobusContextProvider>
23-
<Globus atmosphereEnabled={false}>
22+
render: (args: EntityParams) => <GlobeContextProvider>
23+
<Globe>
2424
<Vector name={'test'}
2525
scaleByDistance={[6000000, 24000000, 10000000000]}>
2626
<Entity name="Custom Entity"
@@ -32,6 +32,6 @@ export const Default: Story = {
3232
/>
3333
</Entity>
3434
</Vector>
35-
</Globus>
36-
</GlobusContextProvider>
35+
</Globe>
36+
</GlobeContextProvider>
3737
};

‎src/entity/Entity/Entity.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import * as React from "react";
22
import {useCallback, useContext, useEffect, useRef, useState} from "react";
3-
import {useGlobusContext} from '@/index';
3+
import {useGlobeContext} from '@/index';
44
import {
55
Billboard as GlobusBillboard,
66
Entity as GlobusEntity,
@@ -36,7 +36,7 @@ export interface EntityParams extends IEntityParams {
3636
}
3737

3838
const Entity: React.FC<EntityParams> = ({visibility, lon, lat, alt, lonlat, name, children, ...rest}) => {
39-
const {globus} = useGlobusContext();
39+
const {globe} = useGlobeContext();
4040
const {
4141
addEntity,
4242
removeEntity,
@@ -79,19 +79,19 @@ const Entity: React.FC<EntityParams> = ({visibility, lon, lat, alt, lonlat, name
7979
}, [visibility]);
8080

8181
useEffect(() => {
82-
if (globus) {
82+
if (globe) {
8383
entityRef.current = new GlobusEntity({
8484
lonlat, name, ...rest
8585
});
8686
addEntity(entityRef.current);
8787

8888
return () => {
89-
if (globus && entityRef.current) {
89+
if (globe && entityRef.current) {
9090
removeEntity(entityRef.current);
9191
}
9292
};
9393
}
94-
}, [globus, addEntity, removeEntity]);
94+
}, [globe, addEntity, removeEntity]);
9595

9696
useEffect(() => {
9797
if (billboard && !entityRef.current?.billboard) entityRef.current?.setBillboard(billboard);

‎src/entity/GeoObject/GeoObject.stories.tsx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React from 'react';
22
import type {Meta, StoryObj} from '@storybook/react';
33

44
import {Entity, GeoObject, GeoObjectParams} from '@/entity';
5-
import {Globus, GlobusContextProvider} from "@/Globe";
5+
import {Globe, GlobeContextProvider} from "@/Globe";
66
import {Vector} from "@/layer";
77

88
const meta = {
@@ -26,8 +26,8 @@ export const Default: Story = {
2626
objSrc: 'https://raw.githubusercontent.com/pavletto/og_resources/main/geo_object/penguin.obj',
2727
textureSrc: 'https://raw.githubusercontent.com/pavletto/og_resources/main/geo_object/penguin.png',
2828
},
29-
render: (args: GeoObjectParams) => <GlobusContextProvider>
30-
<Globus atmosphereEnabled={false}>
29+
render: (args: GeoObjectParams) => <GlobeContextProvider>
30+
<Globe>
3131
<Vector name={'test'}
3232
scaleByDistance={[100, 4000000, 1]}>
3333
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -36,16 +36,16 @@ export const Default: Story = {
3636
/>
3737
</Entity>
3838
</Vector>
39-
</Globus>
40-
</GlobusContextProvider>
39+
</Globe>
40+
</GlobeContextProvider>
4141
};
4242
export const Untextured: Story = {
4343
args: {
4444
...Default.args,
4545
textureSrc: undefined
4646
},
47-
render: (args: GeoObjectParams) => <GlobusContextProvider>
48-
<Globus atmosphereEnabled={false}>
47+
render: (args: GeoObjectParams) => <GlobeContextProvider>
48+
<Globe>
4949
<Vector name={'test'}
5050
scaleByDistance={[100, 4000000, 1]}>
5151
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -54,8 +54,8 @@ export const Untextured: Story = {
5454
/>
5555
</Entity>
5656
</Vector>
57-
</Globus>
58-
</GlobusContextProvider>
57+
</Globe>
58+
</GlobeContextProvider>
5959
};
6060

6161
export const Barrel: Story = {
@@ -64,8 +64,8 @@ export const Barrel: Story = {
6464
textureSrc: 'https://raw.githubusercontent.com/PrincessGod/objTo3d-tiles/master/bin/barrel/barrel.png',
6565
objSrc: 'https://raw.githubusercontent.com/PrincessGod/objTo3d-tiles/master/bin/barrel/barrel.obj'
6666
},
67-
render: (args: GeoObjectParams) => <GlobusContextProvider>
68-
<Globus atmosphereEnabled={false}>
67+
render: (args: GeoObjectParams) => <GlobeContextProvider>
68+
<Globe>
6969
<Vector name={'test'}
7070
scaleByDistance={[100, 4000000, 1]}>
7171
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -74,8 +74,8 @@ export const Barrel: Story = {
7474
/>
7575
</Entity>
7676
</Vector>
77-
</Globus>
78-
</GlobusContextProvider>
77+
</Globe>
78+
</GlobeContextProvider>
7979
};
8080

8181
// export const Default = (args: BillboardParams) =>

‎src/entity/Geometry/Geometry.stories.tsx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import React from 'react';
22
import type {Meta, StoryObj} from '@storybook/react';
33

44
import {Entity, Geometry, GeometryParams} from '@/entity';
5-
import {Globus, GlobusContextProvider} from "@/Globe";
5+
import {Globe, GlobeContextProvider} from "@/Globe";
66
import {Vector} from "@/layer";
77

88
const meta = {
@@ -26,8 +26,8 @@ export const Polygon: Story = {
2626
visibility: true,
2727
},
2828
render: (args: GeometryParams) => {
29-
return <GlobusContextProvider>
30-
<Globus atmosphereEnabled={false}
29+
return <GlobeContextProvider>
30+
<Globe
3131
fontsSrc={"https://openglobus.org/examples/examples/fonts/fonts"}>
3232
<Vector name={'test'}>
3333
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -36,8 +36,8 @@ export const Polygon: Story = {
3636
/>
3737
</Entity>
3838
</Vector>
39-
</Globus>
40-
</GlobusContextProvider>;
39+
</Globe>
40+
</GlobeContextProvider>;
4141
}
4242
};
4343
export const Point: Story = {
@@ -51,8 +51,8 @@ export const Point: Story = {
5151
visibility: true,
5252
},
5353
render: (args: GeometryParams) => {
54-
return <GlobusContextProvider>
55-
<Globus atmosphereEnabled={false}
54+
return <GlobeContextProvider>
55+
<Globe
5656
fontsSrc={"https://openglobus.org/examples/examples/fonts/fonts"}>
5757
<Vector name={'test'}>
5858
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -61,8 +61,8 @@ export const Point: Story = {
6161
/>
6262
</Entity>
6363
</Vector>
64-
</Globus>
65-
</GlobusContextProvider>;
64+
</Globe>
65+
</GlobeContextProvider>;
6666
}
6767
}
6868
export const Line: Story = {
@@ -74,8 +74,8 @@ export const Line: Story = {
7474
visibility: true,
7575
},
7676
render: (args: GeometryParams) => {
77-
return <GlobusContextProvider>
78-
<Globus atmosphereEnabled={false}
77+
return <GlobeContextProvider>
78+
<Globe
7979
fontsSrc={"https://openglobus.org/examples/examples/fonts/fonts"}>
8080
<Vector name={'test'}>
8181
<Entity name="Custom Entity" lon={0} lat={0} alt={0}>
@@ -84,7 +84,7 @@ export const Line: Story = {
8484
/>
8585
</Entity>
8686
</Vector>
87-
</Globus>
88-
</GlobusContextProvider>;
87+
</Globe>
88+
</GlobeContextProvider>;
8989
}
9090
}

0 commit comments

Comments
 (0)