Module Context
Expand source code
# Copyright (C) 2024
# Wassim Jabi <wassim.jabi@gmail.com>
#
# This program is free software: you can redistribute it and/or modify it under
# the terms of the GNU Affero General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
# details.
#
# You should have received a copy of the GNU Affero General Public License along with
# this program. If not, see <https://www.gnu.org/licenses/>.
import topologic_core as topologic
class Context:
@staticmethod
def ByTopologyParameters(topology, u = 0.5, v = 0.5, w = 0.5):
"""
Creates a context object represented by the input topology.
Parameters
----------
topology : topologic_core.Topology
The input topology.
u : float , optional
The input *u* parameter. This defines the relative parameteric location of the content object along the *u* axis.
v : TYPE
The input *v* parameter. This defines the relative parameteric location of the content object along the *v* axis..
w : TYPE
The input *w* parameter. This defines the relative parameteric location of the content object along the *w* axis.
Returns
-------
topologic_core.Context
The created context object. See Aperture.ByObjectContext.
"""
from topologicpy.Topology import Topology
if not Topology.IsInstance(topology, "Topology"):
print("Context.ByTopologyParameters - Error: The input topology parameter is not a valid topologic topology. Returning None.")
return None
context = None
try:
context = topologic.Context.ByTopologyParameters(topology, u, v, w) # Hook to Core
except:
print("Context.ByTopologyParameters - Error: The operation failed. Returning None.")
context = None
return context
@staticmethod
def Topology(context):
"""
Returns the topology of the input context.
Parameters
----------
context : topologic_core.Context
The input context.
Returns
-------
topologic_core.Topology
The topology of the input context.
"""
from topologicpy.Topology import Topology
if not Topology.IsInstance(context, "Context"):
print("Context.Topology - Error: The input context parameter is not a valid topologic context. Returning None.")
return None
topology = None
try:
topology = context.Topology()
except:
print("Context.Topology - Error: The operation failed. Returning None.")
topology = None
return topology
Classes
class Context
-
Expand source code
class Context: @staticmethod def ByTopologyParameters(topology, u = 0.5, v = 0.5, w = 0.5): """ Creates a context object represented by the input topology. Parameters ---------- topology : topologic_core.Topology The input topology. u : float , optional The input *u* parameter. This defines the relative parameteric location of the content object along the *u* axis. v : TYPE The input *v* parameter. This defines the relative parameteric location of the content object along the *v* axis.. w : TYPE The input *w* parameter. This defines the relative parameteric location of the content object along the *w* axis. Returns ------- topologic_core.Context The created context object. See Aperture.ByObjectContext. """ from topologicpy.Topology import Topology if not Topology.IsInstance(topology, "Topology"): print("Context.ByTopologyParameters - Error: The input topology parameter is not a valid topologic topology. Returning None.") return None context = None try: context = topologic.Context.ByTopologyParameters(topology, u, v, w) # Hook to Core except: print("Context.ByTopologyParameters - Error: The operation failed. Returning None.") context = None return context @staticmethod def Topology(context): """ Returns the topology of the input context. Parameters ---------- context : topologic_core.Context The input context. Returns ------- topologic_core.Topology The topology of the input context. """ from topologicpy.Topology import Topology if not Topology.IsInstance(context, "Context"): print("Context.Topology - Error: The input context parameter is not a valid topologic context. Returning None.") return None topology = None try: topology = context.Topology() except: print("Context.Topology - Error: The operation failed. Returning None.") topology = None return topology
Static methods
def ByTopologyParameters(topology, u=0.5, v=0.5, w=0.5)
-
Creates a context object represented by the input topology.
Parameters
topology
:topologic_core.Topology
- The input topology.
u
:float
, optional- The input u parameter. This defines the relative parameteric location of the content object along the u axis.
v
:TYPE
- The input v parameter. This defines the relative parameteric location of the content object along the v axis..
w
:TYPE
- The input w parameter. This defines the relative parameteric location of the content object along the w axis.
Returns
topologic_core.Context
- The created context object. See Aperture.ByObjectContext.
Expand source code
@staticmethod def ByTopologyParameters(topology, u = 0.5, v = 0.5, w = 0.5): """ Creates a context object represented by the input topology. Parameters ---------- topology : topologic_core.Topology The input topology. u : float , optional The input *u* parameter. This defines the relative parameteric location of the content object along the *u* axis. v : TYPE The input *v* parameter. This defines the relative parameteric location of the content object along the *v* axis.. w : TYPE The input *w* parameter. This defines the relative parameteric location of the content object along the *w* axis. Returns ------- topologic_core.Context The created context object. See Aperture.ByObjectContext. """ from topologicpy.Topology import Topology if not Topology.IsInstance(topology, "Topology"): print("Context.ByTopologyParameters - Error: The input topology parameter is not a valid topologic topology. Returning None.") return None context = None try: context = topologic.Context.ByTopologyParameters(topology, u, v, w) # Hook to Core except: print("Context.ByTopologyParameters - Error: The operation failed. Returning None.") context = None return context
def Topology(context)
-
Returns the topology of the input context.
Parameters
context
:topologic_core.Context
- The input context.
Returns
topologic_core.Topology
- The topology of the input context.
Expand source code
@staticmethod def Topology(context): """ Returns the topology of the input context. Parameters ---------- context : topologic_core.Context The input context. Returns ------- topologic_core.Topology The topology of the input context. """ from topologicpy.Topology import Topology if not Topology.IsInstance(context, "Context"): print("Context.Topology - Error: The input context parameter is not a valid topologic context. Returning None.") return None topology = None try: topology = context.Topology() except: print("Context.Topology - Error: The operation failed. Returning None.") topology = None return topology